openstack/tripleo-ansible
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.

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: I9aaeff342fe7fad68d05acb4843ba371f47d8af4
This commit is contained in:
Andreas Jaeger 2020-06-03 20:33:32 +02:00
parent 64313d1f35
commit 9ea838c19a
3 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/conf.py
View File

@ -55,7 +55,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 --------------------------------------------------
@ -83,9 +83,10 @@ latex_documents = [
# intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/tripleo-ansible'
bug_project = 'tripleo'
bug_tag = 'documentation'
openstackdocs_repo_name = 'openstack/tripleo-ansible'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'tripleo'
openstackdocs_bug_tag = 'documentation'
needed_module_utils = [
'baremetal_deploy',

7
molecule-requirements.txt
View File

@ -15,10 +15,9 @@ netaddr
jinja2>=2.8.0,<3
# this is required for the docs build jobs
sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
openstackdocstheme>=1.29.2 # Apache-2.0
reno>=2.11.3 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
doc8>=0.8.0 # Apache-2.0
bashate>=0.6.0 # Apache-2.0
metalsmith>=0.13.0 # Apache-2.0

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