python-kasa/docs/source/conf.py at 0.9.0 · python-kasa/python-kasa · GitHub

Repository navigation

History

# Configuration file for the Sphinx documentation builder.

# This file only contains a selection of the most common options. For a full

# list see the documentation:

# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,

# add these directories to sys.path here. If the directory is relative to the

# documentation root, use os.path.abspath to make it absolute, like shown here.

import os

import sys

sys.path.insert(0, os.path.abspath("..")) # Will find modules in the docs parent

# -- Project information -----------------------------------------------------

project = "python-kasa"

author = "python-kasa developers"

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = [

"sphinx.ext.autodoc",

"sphinx.ext.coverage",

"sphinx.ext.viewcode",

"sphinx.ext.todo",

"sphinxcontrib.programoutput",

"myst_parser",

]

myst_enable_extensions = [

"colon_fence",

]

# Add any paths that contain templates here, relative to this directory.

templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This pattern also affects html_static_path and html_extra_path.

exclude_patterns = [] # type: ignore

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for

# a list of builtin themes.

html_theme = "sphinx_rtd_theme"

# Add any paths that contain custom static files (such as style sheets) here,

# relative to this directory. They are copied after the builtin static files,

# so a file named "default.css" will overwrite the builtin "default.css".

html_static_path = ["_static"]

todo_include_todos = True

myst_heading_anchors = 3

def setup(app): # noqa: ANN201,ANN001

# add copybutton to hide the >>> prompts, see https://github.com/readthedocs/sphinx_rtd_theme/issues/167

app.add_js_file("copybutton.js")

python-kasa/docs/source/conf.py at 0.9.0 · python-kasa/python-kasa · GitHub

Repository navigation

Expand file tree

Breadcrumbs

conf.py

Latest commit

History

Breadcrumbs

conf.py

File metadata and controls