openstack
/
openstack-ansible-tests
Code Issues Proposed changes

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.

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: Iaf0ccf47069546ecd3c6931b6fa5dd9fd830ef3a
This commit is contained in:
Andreas Jaeger 2020-06-03 17:54:22 +02:00
parent d5828455ad
commit d89297c2d6
3 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -9,8 +9,8 @@
# openstack-ansible-tests repository. Once it merges there, the changes will
# automatically be proposed to all the repositories which use it.
sphinx>=1.8.0,!=2.1.0 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
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
doc8>=0.6.0 # Apache-2.0

7
doc/source/conf.py
View File

@ -65,9 +65,10 @@ target_name = 'openstack-ansible-' + role_name
title = 'OpenStack-Ansible Documentation: ' + role_name + 'role'
# openstackdocstheme options
repository_name = 'openstack/' + target_name
bug_project = 'openstack-ansible'
bug_tag = ''
openstackdocs_repo_name = 'openstack/' + target_name
openstackdocs_pdf_link = True
openstackdocs_bug_project = 'openstack-ansible'
openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

11
releasenotes/source/conf.py
View File

@ -61,11 +61,6 @@ role_name = 'tests'
target_name = 'openstack-ansible-' + role_name
title = 'OpenStack-Ansible Documentation: Central testing repository'
# The link to the browsable source code (for the left hand menu)
oslosphinx_cgit_link = (
"https://opendev.org/openstack/{}".format(target_name)
)
# Release notes do not need a version number in the title, they
# cover multiple releases.
# The full version, including alpha/beta/rc tags.
@ -74,9 +69,9 @@ release = ''
version = ''
# openstackdocstheme options
repository_name = 'openstack/' + target_name
bug_project = 'openstack-ansible'
bug_tag = ''
openstackdocs_repo_name = 'openstack/' + target_name
openstackdocs_bug_project = 'openstack-ansible'
openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.