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_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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: I20ea481c1dd9651258b8ae13da9b1e1ec710482b
This commit is contained in:
Andreas Jaeger 2020-05-21 20:35:43 +02:00 committed by Andreas Jaeger
parent 43128494ed
commit e9854ff408
4 changed files with 15 additions and 10 deletions

View File

@ -30,8 +30,9 @@ except ImportError:
openstackdocstheme = None openstackdocstheme = None
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/virtualbmc' openstackdocs_repo_name = 'openstack/virtualbmc'
use_storyboard = True openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
# 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.
@ -54,7 +55,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

@ -24,7 +24,7 @@ MarkupSafe==1.0
mccabe==0.2.1 mccabe==0.2.1
mock==2.0.0 mock==2.0.0
mox3==0.20.0 mox3==0.20.0
openstackdocstheme==1.20.0 openstackdocstheme==2.2.1
os-client-config==1.28.0 os-client-config==1.28.0
os-testr==1.0.0 os-testr==1.0.0
oslotest==3.2.0 oslotest==3.2.0
@ -41,12 +41,12 @@ python-subunit==1.0.0
pytz==2013.6 pytz==2013.6
PyYAML==3.12 PyYAML==3.12
pyzmq===14.3.1 pyzmq===14.3.1
reno==2.5.0 reno==3.1.0
requests==2.14.2 requests==2.14.2
requestsexceptions==1.2.0 requestsexceptions==1.2.0
restructuredtext-lint==1.1.1 restructuredtext-lint==1.1.1
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.6.2 Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1 sphinxcontrib-websupport==1.0.1
stestr==1.0.0 stestr==1.0.0
stevedore==1.20.0 stevedore==1.20.0

View File

@ -68,6 +68,10 @@ master_doc = 'index'
copyright = '2018, Ironic Developers' copyright = '2018, Ironic Developers'
author = 'Ironic Developers' author = 'Ironic Developers'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/virtualbmc'
openstackdocs_use_storyboard = True
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
@ -90,7 +94,7 @@ language = None
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# 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'
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = False

View File

@ -8,8 +8,8 @@ coverage!=4.4,>=4.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0
flake8-import-order>=0.17.1 # LGPLv3 flake8-import-order>=0.17.1 # LGPLv3
python-subunit>=1.0.0 # Apache-2.0/BSD python-subunit>=1.0.0 # Apache-2.0/BSD
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD
@ -17,4 +17,4 @@ testtools>=2.2.0 # MIT
stestr>=1.0.0 # Apache-2.0 stestr>=1.0.0 # Apache-2.0
# releasenotes # releasenotes
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0