Browse Source

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.

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: I628af06b3702925bef790b3b3d1c47c2d7c7cbb0
changes/35/729135/3
Andreas Jaeger 2 years ago committed by Andreas Jaeger
parent
commit
9995eee4c0
  1. 4
      doc/requirements.txt
  2. 9
      doc/source/conf.py
  3. 9
      releasenotes/source/conf.py

4
doc/requirements.txt

@ -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>=2.0.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
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

9
doc/source/conf.py

@ -27,9 +27,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/coverage2sql'
bug_project = 'coverage2sql'
bug_tag = ''
openstackdocs_repo_name = 'openstack/coverage2sql'
openstackdocs_pdf_link = True
openstackdocs_bug_project = 'coverage2sql'
openstackdocs_bug_tag = ''
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@ -53,7 +54,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 --------------------------------------------------

9
releasenotes/source/conf.py

@ -31,9 +31,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/coverage2sql'
bug_project = 'coverage2sql'
bug_tag = ''
openstackdocs_repo_name = 'openstack/coverage2sql'
openstackdocs_bug_project = 'coverage2sql'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -89,7 +90,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 = []

Loading…
Cancel
Save