openstack/zun-tempest-plugin
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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_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: I3ef12cec64103a3fe2c101d05b211bc94c147d59
This commit is contained in:
Andreas Jaeger 2020-06-01 16:27:45 +02:00
parent 3dc2289538
commit 9232f14ea1
3 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/conf.py
View File

@ -40,9 +40,10 @@ project = u'zun-tempest-plugin'
copyright = u'2017, OpenStack Developers' copyright = u'2017, OpenStack Developers'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/zun-tempest-plugin' openstackdocs_repo_name = 'openstack/zun-tempest-plugin'
bug_project = 'zun' openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = 'zun'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True add_function_parentheses = True
@ -52,7 +53,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 --------------------------------------------------

8
releasenotes/source/conf.py
View File

@ -55,9 +55,9 @@ master_doc = 'index'
copyright = u'2017, OpenStack Developers' copyright = u'2017, OpenStack Developers'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/zun_tempest_plugin' openstackdocs_repo_name = 'openstack/zun_tempest_plugin'
bug_project = 'zun' openstackdocs_bug_project = 'zun'
bug_tag = '' openstackdocs_bug_tag = ''
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@ -99,7 +99,7 @@ exclude_patterns = []
# show_authors = False # show_authors = False
# 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'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] # modindex_common_prefix = []

4
test-requirements.txt
View File

@ -5,7 +5,7 @@
hacking>=3.0.1,<3.1.0;python_version>='3.5' # Apache-2.0 hacking>=3.0.1,<3.1.0;python_version>='3.5' # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes # releasenotes
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0