-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconf.py
48 lines (35 loc) · 1.2 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
"""Configuration file for the Sphinx documentation builder.
For the full list of built-in configuration values, see the documentation:
https://www.sphinx-doc.org/en/master/usage/configuration.html
Project information
https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
"""
project = "octo-slample"
copyright = "2023, Pete Baker <[email protected]>"
author = "Pete Baker <[email protected]>"
release = "1.0.0"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinx_click.ext",
"sphinx_rtd_theme",
"sphinx.ext.coverage",
"autoapi.extension",
]
exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
".pytest_cache",
"venv",
]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "sphinx_rtd_theme"
coverage_show_missing_items = True
autoapi_type = "python"
autoapi_dirs = ["octo_slample"]