|
1 | 1 | import os |
2 | 2 | import sys |
| 3 | +from datetime import datetime |
3 | 4 |
|
4 | | -sys.path.insert(0, os.path.abspath('..')) |
| 5 | +sys.path.insert(0, os.path.abspath("..")) |
5 | 6 |
|
6 | | -import sphinx_rtd_theme # noqa |
| 7 | +from minos import common |
| 8 | + |
| 9 | +exclude_patterns = [ |
| 10 | + "standard/docs/*.md", # FIXME: Include these directories. |
| 11 | + "standard/docs/architecture/*.md", # FIXME: Include these directories. |
| 12 | + "_build", |
| 13 | + "Thumbs.db", |
| 14 | + ".DS_Store", |
| 15 | +] |
7 | 16 |
|
8 | 17 | extensions = [ |
| 18 | + "sphinx.ext.autodoc", |
9 | 19 | "sphinx.ext.viewcode", |
10 | | - "sphinx_rtd_theme", |
| 20 | + "sphinx.ext.intersphinx", |
| 21 | + "sphinx.ext.autosummary", |
11 | 22 | "m2r2", |
12 | 23 | ] |
| 24 | +templates_path = ["_templates"] |
| 25 | +source_suffix = [".rst", ".md"] |
13 | 26 |
|
14 | | -source_suffix = ['.rst', '.md'] |
15 | | - |
16 | | -master_doc = 'index' |
17 | | - |
18 | | -project = 'Minos Python' |
19 | | -copyright = "2021, Clariteia" |
| 27 | +master_doc = "index" |
| 28 | +project = "minos-python" |
| 29 | +copyright = f"2021-{datetime.now().year}, Clariteia" |
20 | 30 | author = "Minos Framework Devs" |
21 | 31 |
|
22 | | -language = None |
23 | | - |
24 | | -templates_path = ['_templates'] |
25 | | - |
26 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
27 | | - |
28 | | -pygments_style = 'sphinx' |
29 | | - |
30 | | -todo_include_todos = False |
31 | | - |
32 | | -html_theme = 'sphinx_rtd_theme' |
33 | | - |
34 | | -html_extra_path = ['api-reference'] |
| 32 | +version = common.__version__ |
| 33 | +release = common.__version__ |
35 | 34 |
|
| 35 | +html_theme = "sphinx_rtd_theme" |
36 | 36 | html_sidebars = {"**": ["about.html", "navigation.html", "searchbox.html"]} |
37 | | - |
38 | 37 | html_static_path = ["_static"] |
| 38 | + |
| 39 | +autodoc_default_options = { |
| 40 | + "members": True, |
| 41 | + "undoc-members": True, |
| 42 | + "inherited-members": True, |
| 43 | + "show-inheritance": True, |
| 44 | + "member-order": "bysource", |
| 45 | +} |
| 46 | +autodoc_mock_imports = [ |
| 47 | + "unittest", |
| 48 | +] |
| 49 | + |
| 50 | +autoclass_content = "class" |
| 51 | +autodoc_class_signature = "separated" |
| 52 | +autodoc_member_order = "bysource" |
| 53 | +autodoc_typehints_format = "short" |
| 54 | +autodoc_typehints = "description" |
| 55 | +autodoc_preserve_defaults = True |
| 56 | +add_module_names = False |
| 57 | +intersphinx_mapping = { |
| 58 | + "python": ("https://docs.python.org/3", None), |
| 59 | +} |
| 60 | +autosummary_generate = True |
0 commit comments