openstack/ironic-python-agent
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.

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.
This repo uses storyboard, configure the proper variables.

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

Change-Id: Id084bfc9d5ae7a95d3cba22a00b4c03a35967ee4
This commit is contained in:
Andreas Jaeger 2020-05-21 14:36:15 +02:00
parent bfa184e88d
commit f108b7a2d0
4 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/conf.py
View File

@ -34,7 +34,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 --------------------------------------------------
@ -44,12 +44,12 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = 'openstack/ironic-python-agent'
bug_project = 'ironic-python-agent'
bug_tag = ''
openstackdocs_repo_name = 'openstack/ironic-python-agent'
openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
# Output file base name for HTML help builder.
htmlhelp_basename = 'Ironic Python Agentdoc'
htmlhelp_basename = 'Ironic Python Agentdoc'
latex_use_xindy = False

6
lower-constraints.txt
View File

@ -36,7 +36,7 @@ mox3==0.25.0
msgpack-python==0.5.6
netaddr==0.7.19
netifaces==0.10.4
openstackdocstheme==1.20.0
openstackdocstheme==2.2.1
os-client-config==1.29.0
oslo.concurrency==3.26.0
oslo.config==5.2.0
@ -64,7 +64,7 @@ python-subunit==1.2.0
pytz==2018.3
pyudev==0.18
PyYAML==3.12
reno==2.5.0
reno==3.1.0
repoze.lru==0.7
requests==2.14.2
requestsexceptions==1.4.0
@ -75,7 +75,7 @@ rtslib-fb==2.1.65
six==1.14.0
smmap==3.0.2
snowballstemmer==1.2.1
Sphinx==1.6.2
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stestr==1.0.0
stevedore==1.20.0

8
releasenotes/source/conf.py
View File

@ -95,7 +95,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 = []
@ -111,9 +111,9 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = 'openstack/ironic-python-agent'
bug_project = 'ironic-python-agent'
bug_tag = ''
openstackdocs_repo_name = 'openstack/ironic-python-agent'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

6
test-requirements.txt
View File

@ -12,6 +12,6 @@ bandit!=1.6.0,>=1.1.0,<2.0.0 # Apache-2.0
# Doc requirements
doc8>=0.6.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0