Mercurial > p > roundup > code
comparison doc/conf.py @ 8572:63665d93940b
doc: reconcile and make build_doc work for sphinx-9
Building docs using setup.py build_doc failed with sphinx 9.x.
However building in website/www works.
Try to bring layout.html for doc closer to www. Also update conf.py to
make them closer. They are a little different because website has
additional functionality, but try to make them closer.
This commit works with sphinx 7, 8 and 9.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 14 Apr 2026 13:39:39 -0400 |
| parents | b0539a19ca65 |
| children |
comparison
equal
deleted
inserted
replaced
| 8571:ae1d77e99ad6 | 8572:63665d93940b |
|---|---|
| 18 # All configuration values have a default; values that are commented out | 18 # All configuration values have a default; values that are commented out |
| 19 # serve to show the default. | 19 # serve to show the default. |
| 20 | 20 |
| 21 import sys | 21 import sys |
| 22 import os | 22 import os |
| 23 | |
| 24 | 23 |
| 25 # Read Roundup version by importing it from parent directory, | 24 # Read Roundup version by importing it from parent directory, |
| 26 # this ensures that 'unknown version' is inserted even if | 25 # this ensures that 'unknown version' is inserted even if |
| 27 # `roundup` is importable from other location in sys.path | 26 # `roundup` is importable from other location in sys.path |
| 28 SYSSAVE = sys.path | 27 SYSSAVE = sys.path |
| 49 | 48 |
| 50 # Add any Sphinx extension module names here, as strings. They can be | 49 # Add any Sphinx extension module names here, as strings. They can be |
| 51 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | 50 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 52 # ones. | 51 # ones. |
| 53 #extensions = ['toctree'] | 52 #extensions = ['toctree'] |
| 54 extensions = ['sphinx_tabs.tabs', 'sphinx.ext.autodoc'] | 53 extensions = ['sphinx.ext.autodoc', 'sphinx_tabs.tabs'] |
| 55 | 54 |
| 56 sphinx_tabs_valid_builders = ['linkcheck'] | 55 sphinx_tabs_valid_builders = ['linkcheck'] |
| 57 sphinx_tabs_disable_tab_closing = True | 56 sphinx_tabs_disable_tab_closing = True |
| 58 | 57 autodoc_use_legacy_class_based = True |
| 59 # Add any paths that contain templates here, relative to this directory. | 58 # Add any paths that contain templates here, relative to this directory. |
| 60 templates_path = ['_templates'] | 59 templates_path = ['_templates'] |
| 61 | 60 |
| 62 # The suffix(es) of source filenames. | 61 # The suffix(es) of source filenames. |
| 63 # You can specify multiple suffix as a list of string: | 62 # You can specify multiple suffix as a list of string: |
| 117 # If true, sectionauthor and moduleauthor directives will be shown in the | 116 # If true, sectionauthor and moduleauthor directives will be shown in the |
| 118 # output. They are ignored by default. | 117 # output. They are ignored by default. |
| 119 #show_authors = False | 118 #show_authors = False |
| 120 | 119 |
| 121 # The name of the Pygments (syntax highlighting) style to use. | 120 # The name of the Pygments (syntax highlighting) style to use. |
| 122 pygments_style = 'sphinx' | 121 pygments_style = 'borland' |
| 123 | 122 |
| 124 # disable permalinks | 123 # disable permalinks |
| 125 from sphinx import version_info | 124 from sphinx import version_info |
| 126 if version_info < (3,5,0): | 125 if version_info < (3,5,0): |
| 127 html_add_permalinks = '' | 126 html_add_permalinks = '' |
| 179 # Add any extra paths that contain custom files (such as robots.txt or | 178 # Add any extra paths that contain custom files (such as robots.txt or |
| 180 # .htaccess) here, relative to this directory. These files are copied | 179 # .htaccess) here, relative to this directory. These files are copied |
| 181 # directly to the root of the documentation. | 180 # directly to the root of the documentation. |
| 182 html_extra_path = ['html_extra'] | 181 html_extra_path = ['html_extra'] |
| 183 | 182 |
| 183 # If true, SmartyPants will be used to convert quotes and dashes to | |
| 184 # typographically correct entities. | |
| 185 #html_use_smartypants = True | |
| 186 | |
| 184 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | 187 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 185 # using the given strftime format. | 188 # using the given strftime format. |
| 186 html_last_updated_fmt = '%b %d, %Y' | 189 html_last_updated_fmt = '%b %d, %Y' |
| 187 | |
| 188 # If true, SmartyPants will be used to convert quotes and dashes to | |
| 189 # typographically correct entities. | |
| 190 #html_use_smartypants = True | |
| 191 | 190 |
| 192 # Custom sidebar templates, maps document names to template names. | 191 # Custom sidebar templates, maps document names to template names. |
| 193 #html_sidebars = {} | 192 #html_sidebars = {} |
| 194 | 193 |
| 195 # Additional templates that should be rendered to pages, maps page names to | 194 # Additional templates that should be rendered to pages, maps page names to |