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