1# Configuration file for the Sphinx documentation builder.
2#
3# This file only contains a selection of the most common options. For a full
4# list see the documentation:
5# http://www.sphinx-doc.org/en/master/config
6# -- Path setup --------------------------------------------------------------
7# If extensions (or modules to document with autodoc) are in another directory,
8# add these directories to sys.path here. If the directory is relative to the
9# documentation root, use os.path.abspath to make it absolute, like shown here.
10#
11# import os
12# import sys
13# sys.path.insert(0, os.path.abspath('.'))
14import platform
15from datetime import datetime
16from zoneinfo import ZoneInfo
17
18import sphinx
19import sphinx_material
20from recommonmark.transform import AutoStructify
21
22
23# If extensions (or modules to document with autodoc) are in another directory,
24# add these directories to sys.path here. If the directory is relative to the
25# documentation root, use os.path.abspath to make it absolute, like shown here.
26# sys.path.insert(0, os.path.abspath("./src"))
27
28project = "Tuto programming"
29html_title = project
30
31author = f"DevOps people"
32html_logo = "images/katie_bouman.jpeg"
33html_favicon = "images/katie_bouman.jpeg"
34release = "0.1.0"
35now = datetime.now(tz=ZoneInfo("Europe/Paris"))
36version = f"{now.year}-{now.month:02}-{now.day:02} {now.hour:02}H ({now.tzinfo})"
37today = version
38
39extensions = [
40 "sphinx.ext.autodoc",
41 "sphinx.ext.doctest",
42 "sphinx.ext.extlinks",
43 "sphinx.ext.intersphinx",
44 "sphinx.ext.todo",
45 "sphinx.ext.mathjax",
46 "sphinx.ext.viewcode",
47 "recommonmark",
48 "sphinx_markdown_tables",
49 "sphinx_copybutton",
50]
51extensions += ["sphinx.ext.intersphinx"]
52
53
54autosummary_generate = True
55autoclass_content = "class"
56
57# Add any paths that contain templates here, relative to this directory.
58templates_path = ["_templates"]
59exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
60html_static_path = ["_static"]
61html_show_sourcelink = True
62html_sidebars = {
63 "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
64}
65extensions.append("sphinx_material")
66html_theme_path = sphinx_material.html_theme_path()
67html_context = sphinx_material.get_html_context()
68html_theme = "sphinx_material"
69
70extensions.append("sphinx.ext.intersphinx")
71intersphinx_mapping = {
72 "python": ("https://gdevops.gitlab.io/tuto_python/", None),
73 "git": ("https://gdevops.gitlab.io/tuto_git/", None),
74 "languages": ("https://gdevops.gitlab.io/tuto_languages/", None),
75 "tuto_programming": ("https://gdevops.gitlab.io/tuto_programming/", None),
76 "django": ("https://gdevops.gitlab.io/tuto_django/", None),
77 "docker": ("https://gdevops.gitlab.io/tuto_docker/", None),
78 "databases": ("https://gdevops.gitlab.io/tuto_databases/", None),
79 "javascript": ("https://gdevops.gitlab.io/tuto_javascript/", None),
80 "sphinx": ("https://www.sphinx-doc.org/en/master", None),
81 "sphinx_material": ("https://gdevops.gitlab.io/tuto_sphinx_material", None),
82}
83extensions.append("sphinx.ext.todo")
84todo_include_todos = True
85
86extensions += [
87 "sphinx_panels",
88]
89extensions += ["sphinx_tabs.tabs"]
90# Panels config
91panels_add_bootstrap_css = False
92
93# autoclasstoc + napoleon + autodoc
94# https://autoclasstoc.readthedocs.io/en/latest/basic_usage.html
95extensions += [
96 "autoclasstoc",
97 "sphinx.ext.napoleon",
98 "sphinx.ext.autodoc",
99 "sphinx.ext.autosummary",
100 "sphinx.ext.viewcode",
101]
102autodoc_default_options = {
103 "members": True,
104 "special-members": True,
105 "private-members": True,
106 "inherited-members": True,
107 "undoc-members": True,
108 "exclude-members": "__weakref__",
109}
110
111# material theme options (see theme.conf for more information)
112# https://gitlab.com/bashtage/sphinx-material/blob/master/sphinx_material/sphinx_material/theme.conf
113# Colors
114# The theme color for mobile browsers. Hex color.
115# theme_color = #3f51b5
116# Primary colors:
117# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
118# teal, green, light-green, lime, yellow, amber, orange, deep-orange,
119# brown, grey, blue-grey, white
120# Accent colors:
121# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
122# teal, green, light-green, lime, yellow, amber, orange, deep-orange
123# color_accent = blue
124# color_primary = blue-grey
125
126# material theme options (see theme.conf for more information)
127html_theme_options = {
128 "base_url": "https://gdevops.gitlab.io/tuto_programming/",
129 "repo_url": "https://gitlab.com/gdevops/tuto_programming",
130 "repo_name": project,
131 "html_minify": False,
132 "html_prettify": True,
133 "css_minify": True,
134 "repo_type": "gitlab",
135 "globaltoc_depth": -1,
136 "color_primary": "green",
137 "color_accent": "cyan",
138 "theme_color": "#2196f3",
139 "nav_title": f"{project} ({today})",
140 "master_doc": False,
141 "nav_links": [
142 {
143 "href": "genindex",
144 "internal": True,
145 "title": "Index",
146 },
147 {
148 "href": "https://gdevops.gitlab.io/tuto_python",
149 "internal": False,
150 "title": "Tuto python",
151 },
152 {
153 "href": "https://gdevops.gitlab.io/tuto_devops/",
154 "internal": False,
155 "title": "Tutos devops",
156 },
157 ],
158 "heroes": {
159 "index": "Tuto programming",
160 },
161 "table_classes": ["plain"],
162}
163
164
165language = "en"
166html_last_updated_fmt = ""
167
168todo_include_todos = True
169
170html_use_index = True
171html_domain_indices = True
172
173
174# Enable eval_rst in markdown
175def setup(app):
176 app.add_config_value(
177 "recommonmark_config",
178 {"enable_math": True, "enable_inline_math": True, "enable_eval_rst": True},
179 True,
180 )
181 app.add_transform(AutoStructify)
182 app.add_object_type(
183 "confval",
184 "confval",
185 objname="configuration value",
186 indextemplate="pair: %s; configuration value",
187 )
188
189
190copyright = f"2018-{now.year}, {author} Built with sphinx {sphinx.__version__} Python {platform.python_version()}"