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.

Disable openstackdocs_auto_name to use 'project' variable 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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ic10edb7103455b477cece3940f150f4345611562
This commit is contained in:
Andreas Jaeger 2020-05-21 20:20:42 +02:00 committed by Pierre Riteau
parent b4606341ec
commit 87c91cc615
3 changed files with 14 additions and 11 deletions

View File

@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstackdocstheme>=1.19.0 # Apache-2.0
reno!=2.3.1,>=1.8.0 # Apache-2.0
sphinx>=1.8.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

View File

@ -90,10 +90,12 @@ latex_documents = [
latex_use_xindy = False
# openstackdocstheme options
repository_name = 'openstack/kayobe'
use_storyboard = True
openstackdocs_repo_name = 'openstack/kayobe'
openstackdocs_pdf_link = True
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
openstack_projects = [
openstackdocs_projects = [
'bifrost',
'diskimage-builder',
'ironic',

View File

@ -133,10 +133,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
@ -253,6 +249,11 @@ texinfo_documents = [
# -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/']
openstack_projects = [
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/kayobe'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False
openstackdocs_projects = [
'kayobe',
]