openstack/sushy-cli
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

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

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.

Add openstackdocstheme configuration.

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

Change-Id: I95111319d58e8d7625085cb486be1d0c194196b5
This commit is contained in:
Andreas Jaeger 2020-05-24 15:08:38 +02:00
parent e2e383aa31
commit a66bb0df20
3 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,4 +1,4 @@
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD

7
doc/source/conf.py
View File

@ -40,6 +40,11 @@ master_doc = 'index'
# General information about the project.
copyright = u'2020, OpenStack Foundation'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/sushy-cli'
openstackdocs_use_storyboard = True
openstackdocs_pdf_link = True
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -48,7 +53,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 --------------------------------------------------

7
releasenotes/source/conf.py
View File

@ -58,6 +58,11 @@ master_doc = 'index'
project = u'sushy-cli Release Notes'
copyright = u'2020, OpenStack Foundation'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/sushy-cli'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False
# 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.
@ -98,7 +103,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 = []