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
|
from datetime import datetime
from os import environ, getcwd
from os.path import abspath, join, dirname
import sys
from invocations.environment import in_ci
# Core settings
extensions = [
"releases",
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"invocations.autodoc",
]
templates_path = ["_templates"]
source_suffix = ".rst"
master_doc = "index"
exclude_patterns = ["_build"]
default_role = "obj"
project = "Invocations"
copyright = f"{datetime.now().year} Jeff Forcier"
# Ensure project directory is on PYTHONPATH for version, autodoc access
sys.path.insert(0, abspath(join(getcwd(), "..")))
# Enforce use of Alabaster (even on RTD) and configure it
html_theme = "alabaster"
html_theme_options = {
"description": "Common/best-practice Invoke tasks and collections",
"github_user": "pyinvoke",
"github_repo": "invocations",
# TODO: make new UA property? only good for full domains and not RTD.io?
# 'analytics_id': 'UA-18486793-X',
"travis_button": False,
"tidelift_url": "https://tidelift.com/subscription/pkg/pypi-invocations?utm_source=pypi-invocations&utm_medium=referral&utm_campaign=docs", # noqa
}
html_sidebars = {
"**": ["about.html", "navigation.html", "searchbox.html", "donate.html"]
}
# Other extension configs
autodoc_default_options = {
"members": True,
"special-members": True,
}
# Without this, as of Sphinx 4-ish? our autodoc plugin goes boom because its
# parent class (in sphinx itself!) isn't in our reference tree & the ref fails
autodoc_inherit_docstrings = False
releases_github_path = "pyinvoke/invocations"
# Intersphinx
# TODO: this could probably get wrapped up into us or some other shared lib?
on_rtd = environ.get("READTHEDOCS") == "True"
on_dev = not (on_rtd or in_ci())
# Invoke
inv_target = join(
dirname(__file__), "..", "..", "invoke", "sites", "docs", "_build"
)
if not on_dev:
inv_target = "http://docs.pyinvoke.org/en/latest/"
# Put them all together, + Python core
intersphinx_mapping = {
"python": ("http://docs.python.org/", None),
"invoke": (inv_target, None),
}
|
