openstack/ironic-lib
Code Issues Proposed changes

Switch to newer openstackdocstheme version

Browse Source 
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.

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: I9dfa47d28d3f76115d6cf6dd86ea04d621d99c65
This commit is contained in:
Andreas Jaeger 2020-05-21 13:08:40 +02:00
parent 99a7f13724
commit 84d6c4ffc9
2 changed files with 6 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -1,3 +1,3 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
sphinxcontrib-apidoc>=0.2.0 # BSD

18
doc/source/conf.py
View File

@ -29,17 +29,6 @@ master_doc = 'index'
# General information about the project.
copyright = u'OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
from ironic_lib import version as il_version
# The full version, including alpha/beta/rc tags.
release = il_version.version_info.release_string()
# The short X.Y version.
version = il_version.version_info.version_string()
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['ironic_lib']
@ -51,7 +40,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 --------------------------------------
@ -71,8 +60,9 @@ apidoc_excluded_paths = [
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = 'openstack/ironic-lib'
use_storyboard = True
openstackdocs_repo_name = 'openstack/ironic-lib'
openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
# Output file base name for HTML help builder.
htmlhelp_basename = 'ironic-libdoc'