openstack
/
puppet-openstack-specs
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_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: I953c3393b32a48b1846d4bcb0159c1e3d5806beb
This commit is contained in:
Andreas Jaeger 2020-06-02 14:53:46 +02:00
parent f639f42844
commit a9d00db25b
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/conf.py
View File

@ -25,7 +25,7 @@ extensions = [
]
# Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/puppet-openstack-specs'
feed_base_url = 'https://specs.openstack.org/openstack/puppet-openstack-specs'
feed_author = 'Puppet OpenStack Team'
exclude_patterns = [
@ -54,7 +54,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 --------------------------------------------------
@ -67,6 +67,6 @@ html_static_path = []
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/puppet-openstack-specs'
bug_project = 'puppet-openstack-specs'
bug_tag = ''
openstackdocs_repo_name = 'openstack/puppet-openstack-specs'
openstackdocs_bug_project = 'puppet-openstack-specs'
openstackdocs_bug_tag = ''

4
requirements.txt
View File

@ -1,6 +1,6 @@
pbr!=2.1.0,>=2.0.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
openstackdocstheme>=1.32.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
stestr>=2.0.0
testtools>=0.9.34
yasfb>=0.5.1