openstack
/
tripleo-upgrade
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: I704d232c38e9d4073514ceb3d13b15400f478182
This commit is contained in:
Andreas Jaeger 2020-06-03 20:41:59 +02:00
parent f7b2a5bf1f
commit 4306ed0b5f
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
releasenotes/source/conf.py
View File

@ -88,7 +88,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 = []
@ -268,6 +268,7 @@ texinfo_documents = [
locale_dirs = ['locale/']
# openstackdocstheme options
repository_name = 'openstack/tripleo-upgrade'
bug_project = 'tripleo'
bug_tag = 'documentation'
openstackdocs_repo_name = 'openstack/tripleo-upgrade'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'tripleo'
openstackdocs_bug_tag = 'documentation'

7
test-requirements.txt
View File

@ -1,10 +1,9 @@
# 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.8.0,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
pre-commit==1.13.0 # MIT License
hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
bashate>=0.5.1 # Apache-2.0
openstackdocstheme>=1.19.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0