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.

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: I8544a3024a1769adc3fc534d93f5ecca8720dd3f
This commit is contained in:
Andreas Jaeger 2020-05-30 18:26:44 +02:00 committed by Jiao Pengju
parent fcca3935af
commit 866cf42921
5 changed files with 19 additions and 16 deletions

View File

@ -58,9 +58,10 @@ master_doc = 'index'
project = u'Data Protection API Reference'
copyright = u'OpenStack Foundation'
repository_name = 'openstack/karbor'
bug_project = 'karbor'
bug_tag = 'api-ref'
openstackdocs_repo_name = 'openstack/karbor'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'karbor'
openstackdocs_bug_tag = 'api-ref'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -89,7 +90,7 @@ add_module_names = False
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for man page output ----------------------------------------------

View File

@ -71,7 +71,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'
# -- sphinxcontrib.apidoc configuration --------------------------------------
@ -107,6 +107,7 @@ latex_documents = [
]
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/karbor'
bug_project = project.lower()
bug_tag = ''
openstackdocs_repo_name = 'openstack/karbor'
openstackdocs_auto_name = False
openstackdocs_bug_project = project.lower()
openstackdocs_bug_tag = ''

View File

@ -57,7 +57,7 @@ netaddr==0.7.19
netifaces==0.10.6
networkx==1.11
oauthlib==2.0.6
openstackdocstheme==2.0.0
openstackdocstheme==2.2.1
openstacksdk==0.12.0
os-api-ref==1.4.0
os-client-config==1.29.0
@ -112,7 +112,7 @@ python-swiftclient==3.2.0
python-troveclient==2.2.0
pytz==2018.3
PyYAML==3.12
reno==2.5.0
reno==3.1.0
repoze.lru==0.7
requests-oauthlib==0.8.0
requests==2.14.2

View File

@ -47,9 +47,10 @@ version = ''
release = ''
# openstackdocstheme options
repository_name = 'openstack/karbor'
bug_project = project.lower()
bug_tag = ''
openstackdocs_repo_name = 'openstack/karbor'
openstackdocs_auto_name = False
openstackdocs_bug_project = project.lower()
openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -81,7 +82,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 = []

View File

@ -25,7 +25,7 @@ python-manilaclient>=1.16.0 # Apache-2.0
# Documentation
sphinx>=2.0.0,!=2.1.0 # BSD
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.0.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
sphinxcontrib-apidoc>=0.2.0 # BSD