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
|
from datetime import datetime
import sys
from pathlib import Path
from sphinxcontrib import typer as sphinxcontrib_typer
import shutil
# 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 --------------------------------------------------------------
sys.path.append(str(Path(__file__).parent.parent))
sys.path.append(str(Path(__file__).parent / 'typer_doc_ext'))
# -- Project information -----------------------------------------------------
project = sphinxcontrib_typer.__title__
copyright = sphinxcontrib_typer.__copyright__
author = sphinxcontrib_typer.__author__
release = sphinxcontrib_typer.__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',
'sphinxcontrib.typer',
"sphinx.ext.viewcode",
'sphinx.ext.intersphinx'
]
# 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 = []
# -- 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 = 'furo'
html_theme_options = {
"source_repository": "https://github.com/sphinx-contrib/typer/",
"source_branch": "main",
"source_directory": "doc/source",
}
# 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']
html_css_files = ['style.css']
html_js_files = []
todo_include_todos = True
latex_engine = 'xelatex'
typer_get_web_driver = 'web_driver.typer_get_web_driver'
autodoc_typehints = "description" # or signature
autodoc_typehints_format = "short"
intersphinx_mapping = {
"click": ("https://click.palletsprojects.com/en/stable", None),
"rich": ("https://rich.readthedocs.io/en/stable", None),
"python": ('https://docs.python.org/3', None),
"sphinx-rtd-theme": ("https://sphinx-rtd-theme.readthedocs.io/en/stable", None),
"sphinx-click": ("https://sphinx-click.readthedocs.io/en/stable", None),
"sphinx": ("https://www.sphinx-doc.org/en/master", None)
}
def pypi_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
from docutils import nodes
url = f"https://pypi.org/project/{text}/"
node = nodes.reference(rawtext, text, refuri=url, **options)
return [node], []
def setup(app):
from docutils.parsers.rst import roles
roles.register_local_role("pypi", pypi_role)
if Path(app.doctreedir).exists():
shutil.rmtree(app.doctreedir)
return app
|
