openstack/publiccloud-sig
Code Issues Proposed changes

Switch to newer openstackdocstheme version

Browse Source 
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: I42bbf32877a99d91aade69d93a52a4ace000122c
This commit is contained in:
Andreas Jaeger 2020-06-03 21:01:41 +02:00
parent a670331b47
commit cd0d1c2882
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/conf.py
View File

@ -22,8 +22,8 @@ extensions = [
]
# Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/publiccloud-wg'
feed_author = 'OpenStack Public Cloud Working Group'
feed_base_url = 'https://specs.openstack.org/openstack/publiccloud-wg'
feed_author = 'OpenStack Public Cloud SIG'
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@ -36,13 +36,13 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'publiccloud-wg'
project = u'publiccloud-sig'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'publiccloud-wg-core/publiccloud-wg'
bug_project = 'openstack-publiccloud-wg'
bug_tag = ''
openstackdocs_repo_name = 'openstack/publiccloud-sig'
openstackdocs_bug_project = 'openstack-publiccloud-wg'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -52,7 +52,7 @@ add_function_parentheses = True
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output --------------------------------------------------

4
requirements.txt
View File

@ -2,5 +2,5 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0