-
Notifications
You must be signed in to change notification settings - Fork 12
/
conf.py
67 lines (50 loc) · 1.52 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# flake8: NOQA E501
import inspect
import os
import sys
from os.path import dirname, relpath
from pathlib import Path
import libvcs
# Get the project root dir, which is the parent dir of this
doc_path = Path(__file__).parent
project_root = doc_path.parent
sys.path.insert(0, str(project_root))
sys.path.insert(0, str(doc_path / "_ext"))
# package data
about: dict = {}
with open(project_root / "libvcs" / "__about__.py") as fp:
exec(fp.read(), about)
extensions = [
"sphinx.ext.napoleon", # Should go first
"autoapi.extension",
"sphinx.ext.autodoc",
"sphinx.ext.todo",
"sphinx.ext.intersphinx",
"myst_parser",
]
templates_path = ["_templates"]
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
master_doc = "index"
project = about["__title__"]
copyright = about["__copyright__"]
version = "%s" % (".".join(about["__version__"].split("."))[:2])
release = "%s" % (about["__version__"])
exclude_patterns = ["_build"]
html_theme_path: list = []
# sphinx.ext.autodoc
autoclass_content = "both"
autodoc_member_order = "bysource"
# sphinx-autoapi
autoapi_type = "python"
autoapi_dirs = [project_root / "libvcs"]
autoapi_generate_api_docs = False # when False, use directives
# sphinx.ext.napoleon
napoleon_google_docstring = True
napoleon_include_init_with_doc = True
# sphinx-issues
issues_github_path = "vcs-python/libvcs"
intersphinx_mapping = {
"py": ("https://docs.python.org/3", None),
"pip": ("https://pip.pypa.io/en/latest/", None),
"vcspull": ("https://vcspull.git-pull.com/", None),
}