openstack
/
nova-specs
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions 

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow parallelizing building of documents.

Update Sphinx version as well.

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.

Set openstackdocs_auto_version to not version the documents.
Set openstackdocs_auto_name to use project 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.

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

Change-Id: I6cfa321e91f8a9fdbb9d6392f9740d41290ed545
This commit is contained in:
Andreas Jaeger 2020-05-16 09:28:44 +02:00 committed by Andreas Jaeger
parent 3bc3142246
commit 209947852b
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -1,7 +1,7 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-seqdiag>=0.8.4 # BSD
openstackdocstheme>=1.30.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
yasfb>=0.8.0 # BSD

12
doc/source/conf.py
View File

@ -31,7 +31,7 @@ project = u'Nova Specs'
copyright = u'%s, OpenStack Nova Team' % datetime.date.today().year
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['nova-specs.']
@ -54,13 +54,15 @@ html_use_index = False
# -- openstackdocstheme configuration -----------------------------------------
repository_name = 'openstack/nova-specs'
use_storyboard = False
openstackdocs_repo_name = 'openstack/nova-specs'
openstackdocs_bug_project = 'nova'
openstackdocs_bug_tag = 'specs'
openstackdocs_auto_name = False
openstackdocs_auto_version = False
# -- yasfb configuration ------------------------------------------------------
feed_base_url = 'http://specs.openstack.org/openstack/nova-specs'
feed_base_url = 'https://specs.openstack.org/openstack/nova-specs'
feed_author = 'OpenStack Nova Team'