openstack/heat-agents
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_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: I0494a468b8ccc54e6d6946623a44ece6442d1915
This commit is contained in:
Andreas Jaeger 2020-05-30 17:03:33 +02:00
parent 7872568ed9
commit 0e188d0326
3 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
reno>=3.1.0 # Apache-2.0
sphinxcontrib-httpdomain>=1.3.0 # BSD

8
doc/source/conf.py
View File

@ -82,7 +82,7 @@ language = None
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output ----------------------------------------------
@ -111,9 +111,9 @@ html_theme = 'openstackdocs'
# html_sidebars = {}
# -- Options for openstackdocstheme --------------------------------------
repository_name = 'openstack/heat-agents'
bug_project = '990'
bug_tag = 'docs'
openstackdocs_repo_name = 'openstack/heat-agents'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# -- Options for HTMLHelp output ------------------------------------------

9
releasenotes/source/conf.py
View File

@ -47,9 +47,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/heat-agents'
bug_project = 'heat'
bug_tag = ''
openstackdocs_repo_name = 'openstack/heat-agents'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -91,7 +91,7 @@ language = None
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@ -104,7 +104,6 @@ todo_include_todos = False
#
html_theme = 'openstackdocs'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the