-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathconf.py
More file actions
99 lines (71 loc) · 3.54 KB
/
conf.py
File metadata and controls
99 lines (71 loc) · 3.54 KB
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
"""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.
# pylint: disable=W,C,R
import os
import sys
from pathlib import Path
from sphinx.ext.apidoc import main
try:
import toml
except ImportError:
sys.exit("Please make sure to `pip install toml` or enable the Poetry shell and run `poetry install`.")
# -- Variable setup --------------------------------------------------------------
ROOT_DIR = Path(__file__).parent.parent.parent
CURR_DIR = f"{ROOT_DIR}/docs/source"
PYPROJECT_CONFIG = toml.load(f"{ROOT_DIR}/pyproject.toml")
TOOL_CONFIG = PYPROJECT_CONFIG["tool"]["poetry"]
# Inserts the diffsync library into the path. This is needed for RTD env to find the
# library needed for autodocs.
sys.path.insert(0, os.path.abspath("../.."))
# -- Project information -----------------------------------------------------
project = TOOL_CONFIG["name"]
copyright = f"2020-2021, {','.join(TOOL_CONFIG['authors'])}"
author = ",".join(TOOL_CONFIG["authors"])
# The full version, including alpha/beta/rc tags
release = TOOL_CONFIG["version"]
# -- 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.napoleon", "m2r2"]
autodoc_default_options = {
"members": True,
"show-inheritance": True,
"special-members": "__init__",
"undoc-members": True,
}
# 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 = ["_build", "Thumbs.db", ".DS_Store"]
# -- 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"]
def remove_module_docstring(app, what, name, obj, options, lines):
"""Removes copyright heading on modules to prevent unneeded reference in the API documentation."""
if what == "module":
# At the module level, remove everything except the first line containing a summary of the module. All
# lines that follow are copyright notices.
del lines[1:]
def run_apidoc(_):
"""Adds the sphinx-apidoc command as a callback during the build process."""
main(["-MTfe", "-t", f"{CURR_DIR}/template/api", "-o", f"{CURR_DIR}/api", f"{ROOT_DIR}/{TOOL_CONFIG['name']}"])
def setup(app):
"""Registers the callbacks to be called when the event is emitted."""
app.connect("builder-inited", run_apidoc)
app.connect("autodoc-process-docstring", remove_module_docstring)