openstack
/
molteniron
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 especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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.

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: I69eececbc482575e8e8335d8ba3499b3a86e4be7
This commit is contained in:
Andreas Jaeger 2020-05-30 16:59:27 +02:00
parent 8c4ff32c15
commit 134f2b1800
3 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/conf.py
View File

@ -48,7 +48,11 @@ add_function_parentheses = True
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
openstackdocs_repo_name = 'openstack/molteniron'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False
# -- Options for HTML output --------------------------------------------------

6
releasenotes/source/conf.py
View File

@ -58,6 +58,10 @@ master_doc = 'index'
project = u'molteniron Release Notes'
copyright = u'2016, OpenStack Foundation'
openstackdocs_repo_name = 'openstack/molteniron'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
@ -98,7 +102,7 @@ exclude_patterns = []
# show_authors = False
# 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 = []

6
test-requirements.txt
View File

@ -6,12 +6,12 @@ hacking>=0.11.0,<0.12 # Apache-2.0
coverage>=4.0 # Apache-2.0
python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx>=1.2.1,!=1.3b1,<1.4 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
# releasenotes
reno>=1.8.0 # Apache2
reno>=3.1.0 # Apache-2.0