|
1 | 1 | # -*- coding: utf-8 -*- |
2 | 2 | import os |
3 | 3 | import sys |
4 | | -from datetime import date |
5 | 4 |
|
6 | 5 | from sphinx_scylladb_theme.utils import multiversion_regex_builder |
7 | 6 |
|
8 | 7 | sys.path.insert(0, os.path.abspath('..')) |
9 | 8 | import cassandra |
10 | 9 |
|
11 | | -# -- General configuration ----------------------------------------------------- |
| 10 | +# -- Global variables |
12 | 11 |
|
13 | 12 | # Build documentation for the following tags and branches |
14 | 13 | TAGS = ['3.21.0-scylla', '3.22.3-scylla', '3.24.8-scylla', '3.25.4-scylla', '3.25.11-scylla', '3.26.3-scylla'] |
|
20 | 19 | # Set which versions are deprecated |
21 | 20 | DEPRECATED_VERSIONS = [''] |
22 | 21 |
|
| 22 | +# -- General configuration |
| 23 | + |
23 | 24 | # Add any Sphinx extension module names here, as strings. They can be extensions |
24 | 25 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
25 | 26 | extensions = [ |
|
69 | 70 | # The name of the Pygments (syntax highlighting) style to use. |
70 | 71 | pygments_style = 'sphinx' |
71 | 72 |
|
72 | | -# -- Options for not found extension ------------------------------------------- |
| 73 | +# -- Options for not found extension |
73 | 74 |
|
74 | 75 | # Template used to render the 404.html generated by this extension. |
75 | 76 | notfound_template = '404.html' |
76 | 77 |
|
77 | 78 | # Prefix added to all the URLs generated in the 404 page. |
78 | 79 | notfound_urls_prefix = '' |
79 | 80 |
|
80 | | -# -- Options for multiversion -------------------------------------------------- |
| 81 | +# -- Options for multiversion |
81 | 82 |
|
82 | 83 | # Whitelist pattern for tags |
83 | 84 | smv_tag_whitelist = multiversion_regex_builder(TAGS) |
|
94 | 95 | # Format for versioned output directories inside the build directory |
95 | 96 | smv_outputdir_format = '{ref.name}' |
96 | 97 |
|
97 | | -# -- Options for HTML output -------------------------------------------------- |
| 98 | +# -- Options for sitemap extension |
| 99 | + |
| 100 | +sitemap_url_scheme = "/stable/{link}" |
| 101 | + |
| 102 | +# -- Options for HTML output |
98 | 103 |
|
99 | 104 | # The theme to use for HTML and HTML Help pages. See the documentation for |
100 | 105 | # a list of builtin themes. |
101 | 106 | html_theme = 'sphinx_scylladb_theme' |
102 | 107 |
|
103 | | -# -- Options for sitemap extension --------------------------------------- |
104 | | - |
105 | | -sitemap_url_scheme = "/stable/{link}" |
106 | | - |
107 | 108 | # Theme options are theme-specific and customize the look and feel of a theme |
108 | 109 | # further. For a list of options available for each theme, see the |
109 | 110 | # documentation. |
|
0 commit comments