openstack/oslo.versionedobjects
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.

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.

Set openstackdocs_auto_name to use 'project' 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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I5ebcae5db6b0f9f4dbf0754ace544b6c1e341ec7
This commit is contained in:
Andreas Jaeger 2020-05-16 10:03:06 +02:00 committed by Andreas Jaeger
parent d459c3fe4b
commit dd091c8010
3 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -2,9 +2,9 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
# These are needed for docs generation
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx>=1.8.0,!=2.1.0 # 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
mock>=2.0.0 # BSD
fixtures>=3.0.0 # Apache-2.0/BSD

9
doc/source/conf.py
View File

@ -28,9 +28,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/oslo.versionedobjects'
bug_project = 'oslo.versionedobjects'
bug_tag = ''
openstackdocs_repo_name = 'openstack/oslo.versionedobjects'
openstackdocs_bug_project = 'oslo.versionedobjects'
openstackdocs_bug_tag = ''
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@ -61,7 +61,7 @@ extlinks = {
}
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output --------------------------------------------------
@ -72,7 +72,6 @@ pygments_style = 'sphinx'
# html_static_path = ['static']
html_theme = 'openstackdocs'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project

13
releasenotes/source/conf.py
View File

@ -40,9 +40,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/oslo.versionedobjects'
bug_project = 'oslo.versionedobjects'
bug_tag = ''
openstackdocs_repo_name = 'openstack/oslo.versionedobjects'
openstackdocs_bug_project = 'oslo.versionedobjects'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -97,7 +98,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 = []
@ -146,10 +147,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True