Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 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. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_name to use project as name. Fix wrong indent in index.rst that lead to a grey bar on the left of the toc. Depends-On: https://review.opendev.org/728938 Change-Id: If82be6fbfb12cedd8f9dcfb4468415e085d1c821
This commit is contained in:
@@ -3,9 +3,9 @@
|
||||
# process, which may cause wedges in the gate later.
|
||||
|
||||
# For generating sphinx documentation
|
||||
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.0 # Apache-2.0
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
sphinxcontrib-apidoc>=0.2.0 # BSD
|
||||
|
||||
# For autodoc builds
|
||||
|
||||
@@ -28,9 +28,9 @@ extensions = [
|
||||
]
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/oslo.cache'
|
||||
bug_project = 'oslo.cache'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/oslo.cache'
|
||||
openstackdocs_bug_project = 'oslo.cache'
|
||||
openstackdocs_bug_tag = ''
|
||||
|
||||
# sphinxcontrib.apidoc options
|
||||
apidoc_module_dir = '../../oslo_cache'
|
||||
@@ -39,9 +39,6 @@ apidoc_excluded_paths = [
|
||||
'tests'
|
||||
]
|
||||
|
||||
# Must set this variable to include year, month, day, hours, and minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
|
||||
@@ -40,12 +40,10 @@ extensions = [
|
||||
]
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/oslo.cache'
|
||||
bug_project = 'oslo.cache'
|
||||
bug_tag = ''
|
||||
|
||||
# Must set this variable to include year, month, day, hours, and minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
openstackdocs_repo_name = 'openstack/oslo.cache'
|
||||
openstackdocs_bug_project = 'oslo.cache'
|
||||
openstackdocs_bug_tag = ''
|
||||
openstackdocs_auto_name = False
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
==========================
|
||||
oslo.cache Release Notes
|
||||
==========================
|
||||
========================
|
||||
oslo.cache Release Notes
|
||||
========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
unreleased
|
||||
ussuri
|
||||
train
|
||||
stein
|
||||
rocky
|
||||
queens
|
||||
pike
|
||||
ocata
|
||||
newton
|
||||
unreleased
|
||||
ussuri
|
||||
train
|
||||
stein
|
||||
rocky
|
||||
queens
|
||||
pike
|
||||
ocata
|
||||
newton
|
||||
|
||||
Reference in New Issue
Block a user