openstack
/
cliff
Code Issues Proposed changes

Switch to newer openstackdocstheme version 

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_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: I50caba24ba8d458e5061cf412b8f59e3815c58f7
This commit is contained in:
Andreas Jaeger 2020-05-31 20:31:43 +02:00
parent 2251aef8bf
commit 60ab3cdedf
4 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -1,5 +1,5 @@
# 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,!=2.1.0,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0

9
doc/source/conf.py
View File

@ -51,9 +51,10 @@ if has_openstackdocstheme:
extensions.append('openstackdocstheme')
# openstackdocstheme options
repository_name = 'openstack/cliff'
bug_project = 'python-cliff'
bug_tag = ''
openstackdocs_repo_name = 'openstack/cliff'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'python-cliff'
openstackdocs_bug_tag = ''
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -101,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 = []

2
lower-constraints.txt
View File

@ -26,7 +26,7 @@ requests==2.14.2
six==1.10.0
smmap==0.9.0
snowballstemmer==1.2.1
Sphinx==1.6.2
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stevedore==1.20.0
testrepository==0.0.18

2
test-requirements.txt
View File

@ -12,7 +12,7 @@ coverage!=4.4,>=4.0 # Apache-2.0
# sphinx is required in test-requirements in addition to doc/requirements
# because there is a sphinx extension that has tests
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
# Bandit security code scanner
bandit>=1.1.0 # Apache-2.0