Switch to newer openstackdocstheme version

Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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: I10e31a8883739e8844b9d974cf4da62cfc28efe0
This commit is contained in:
Andreas Jaeger 2020-05-30 16:44:11 +02:00
parent ce31b3f3c0
commit 69f4b79813
4 changed files with 12 additions and 13 deletions

View File

@ -39,9 +39,10 @@ html_theme_options = {
"sidebar_mode": "toc", "sidebar_mode": "toc",
} }
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/ec2-api' openstackdocs_repo_name = 'openstack/ec2-api'
bug_project = 'ec2-api' openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = 'ec2-api'
openstackdocs_bug_tag = ''
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
@ -107,7 +108,7 @@ add_module_names = False
show_authors = False show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for man page output ---------------------------------------------- # -- Options for man page output ----------------------------------------------

View File

@ -2,6 +2,6 @@
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
sphinx>=1.8.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
os-api-ref>=1.5.0 # Apache-2.0 os-api-ref>=1.5.0 # Apache-2.0

View File

@ -23,9 +23,10 @@ extensions = ['sphinx.ext.doctest',
'openstackdocstheme'] 'openstackdocstheme']
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/ec2-api' openstackdocs_repo_name = 'openstack/ec2-api'
bug_project = 'ec2-api' openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = 'ec2-api'
openstackdocs_bug_tag = ''
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles. # text edit cycles.
@ -52,7 +53,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------

View File

@ -49,7 +49,6 @@ munch==2.2.0
netaddr==0.7.19 netaddr==0.7.19
netifaces==0.10.6 netifaces==0.10.6
nose==1.3.7 nose==1.3.7
openstackdocstheme==1.31.2
openstacksdk==0.12.0 openstacksdk==0.12.0
os-api-ref==1.5.0 os-api-ref==1.5.0
os-client-config==1.29.0 os-client-config==1.29.0
@ -98,8 +97,6 @@ Routes==2.4.1
simplejson==3.13.2 simplejson==3.13.2
six==1.11.0 six==1.11.0
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.8.0
sphinxcontrib-websupport==1.0.1
SQLAlchemy==1.2.5 SQLAlchemy==1.2.5
sqlalchemy-migrate==0.11.0 sqlalchemy-migrate==0.11.0
sqlparse==0.2.4 sqlparse==0.2.4