|
9 | 9 | from sphinx_scylladb_theme.utils import multiversion_regex_builder
|
10 | 10 | from redirects_cli import cli as redirects_cli
|
11 | 11 |
|
12 |
| -# -- General configuration ------------------------------------------------ |
| 12 | +# -- General configuration |
13 | 13 |
|
14 | 14 | # Build documentation for the following tags and branches
|
15 | 15 | TAGS = []
|
|
66 | 66 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
67 | 67 | todo_include_todos = True
|
68 | 68 |
|
69 |
| -# -- Options for not found extension ------------------------------------------- |
| 69 | +# -- Options for not found extension |
70 | 70 |
|
71 | 71 | # Template used to render the 404.html generated by this extension.
|
72 | 72 | notfound_template = '404.html'
|
73 | 73 |
|
74 | 74 | # Prefix added to all the URLs generated in the 404 page.
|
75 | 75 | notfound_urls_prefix = ''
|
76 | 76 |
|
77 |
| -# -- Options for multiversion extension ---------------------------------- |
| 77 | +# -- Options for multiversion extension |
78 | 78 |
|
79 | 79 | # Whitelist pattern for tags
|
80 | 80 | smv_tag_whitelist = multiversion_regex_builder(TAGS)
|
|
91 | 91 | # Format for versioned output directories inside the build directory
|
92 | 92 | smv_outputdir_format = '{ref.name}'
|
93 | 93 |
|
94 |
| -# -- Options for sitemap extension --------------------------------------- |
| 94 | +# -- Options for sitemap extension |
95 | 95 |
|
96 | 96 | sitemap_url_scheme = "/stable/{link}"
|
97 | 97 |
|
98 |
| -# -- Options for HTML output ---------------------------------------------- |
| 98 | +# -- Options for HTML output |
99 | 99 |
|
100 | 100 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
101 | 101 | # a list of builtin themes.
|
|
138 | 138 | # Dictionary of values to pass into the template engine’s context for all pages
|
139 | 139 | html_context = {'html_baseurl': html_baseurl}
|
140 | 140 |
|
141 |
| -# -- Initialize Sphinx ---------------------------------------------- |
| 141 | +# -- Initialize Sphinx |
142 | 142 |
|
143 | 143 | class CustomCommonMarkParser(CommonMarkParser):
|
144 | 144 |
|
|
0 commit comments