openstack/reviewstats
Code Issues Proposed changes

Switch to newer openstackdocstheme version

Browse Source 
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_version to not auto-version the documents.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I33db298dd24f1e9795fb789f7c6964a97ba0651f
This commit is contained in:
Andreas Jaeger 2020-06-03 21:10:09 +02:00
parent 707a7c5be0
commit 4be7831173
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -1,2 +1,2 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.20 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0

7
doc/source/conf.py
View File

@ -27,8 +27,9 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/reviewstats' openstackdocs_repo_name = 'openstack/reviewstats'
use_storyboard = True openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -53,7 +54,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------