openstack/openstack-ansible-os_octavia
Code Issues Proposed changes

Use newer openstackdocstheme and reno versions

Browse Source 
The sync from https://review.opendev.org/733244 updated to
openstackdocstheme 2.2.1 and reno 3.1.0 versions.

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: I495d48d0c2a9d83e987bf04abc78fbd15fd6a761
This commit is contained in:
Andreas Jaeger 2020-06-03 18:42:31 +02:00
parent c170f2f9a5
commit 9ce36dc684
2 changed files with 7 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/conf.py
View File

@ -65,15 +65,11 @@ role_name = 'os_octavia'
target_name = 'openstack-ansible-' + role_name target_name = 'openstack-ansible-' + role_name
title = 'OpenStack-Ansible Documentation: ' + role_name + ' role' title = 'OpenStack-Ansible Documentation: ' + role_name + ' role'
# The link to the browsable source code (for the left hand menu)
oslosphinx_cgit_link = (
"https://opendev.org/openstack/{}".format(target_name)
)
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/' + target_name openstackdocs_repo_name = 'openstack/' + target_name
bug_project = project.lower() openstackdocs_pdf_link = True
bug_tag = '' openstackdocs_bug_project = project.lower()
openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

11
releasenotes/source/conf.py
View File

@ -62,11 +62,6 @@ role_name = 'os_heat'
target_name = 'openstack-ansible-' + role_name target_name = 'openstack-ansible-' + role_name
title = 'OpenStack-Ansible Release Notes: ' + role_name + 'role' title = 'OpenStack-Ansible Release Notes: ' + role_name + 'role'
# 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 # Release notes do not need a version number in the title, they
# cover multiple releases. # cover multiple releases.
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
@ -75,9 +70,9 @@ release = ''
version = '' version = ''
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/' + target_name openstackdocs_repo_name = 'openstack/' + target_name
bug_project = project.lower() openstackdocs_bug_project = project.lower()
bug_tag = '' openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.