openstack
/
devstack-plugin-ceph
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions 

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.

Set openstackdocs_auto_version to not auto-version the documents.

Set openstackdocs_auto_name to use 'project' as name.

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.

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: I71e78d4ff18b0fd92f16f0917283eddad543250f
This commit is contained in:
Andreas Jaeger 2020-05-19 10:26:06 +02:00 committed by Andreas Jaeger
parent 6e70fbcf81
commit 6a252c1991
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -1,5 +1,5 @@
# The order of packages is significant, because pip processes them in the order
# 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
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD

10
doc/source/conf.py
View File

@ -27,9 +27,11 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/devstack-plugin-ceph'
bug_project = 'devstack-plugin-ceph'
bug_tag = ''
openstackdocs_repo_name = 'openstack/devstack-plugin-ceph'
openstackdocs_bug_project = 'devstack-plugin-ceph'
openstackdocs_bug_tag = ''
openstackdocs_auto_version = False
openstackdocs_auto_name = False
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@ -53,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 --------------------------------------------------