openstack
/
neutron-vpnaas-dashboard
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.

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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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: Ia039d70c66d05ee0ca64bb8e85920bc36d16831a
This commit is contained in:
Andreas Jaeger 2020-05-23 17:49:37 +02:00
parent 6006487578
commit 854a1c008c
4 changed files with 14 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -2,6 +2,6 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=1.18.1 # 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

24
doc/source/conf.py
View File

@ -22,13 +22,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
from __future__ import print_function
import os
import sys
import neutron_vpnaas_dashboard.version
PROJECT = 'neutron-vpnaas-dashboard'
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
@ -58,10 +54,11 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/neutron-vpnaas-dashboard'
bug_project = 'neutron-vpnaas-dashboard'
bug_tag = 'doc'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
openstackdocs_repo_name = 'openstack/neutron-vpnaas-dashboard'
openstackdocs_pdf_link = True
openstackdocs_auto_name = False
openstackdocs_bug_project = 'neutron-vpnaas-dashboard'
openstackdocs_bug_tag = 'doc'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -79,15 +76,6 @@ master_doc = 'index'
project = u'Neutron VPNaaS Dashboard'
copyright = u'2017, 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.
version = neutron_vpnaas_dashboard.version.version_info.version_string()
# The full version, including alpha/beta/rc tags.
release = neutron_vpnaas_dashboard.version.version_info.release_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -118,7 +106,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 = ['neutron_vpnaas_dashboard.']

4
lower-constraints.txt
View File

@ -51,7 +51,6 @@ munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
nose==1.3.7
openstackdocstheme==1.18.1
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@ -99,7 +98,6 @@ python-swiftclient==3.2.0
pytz==2013.6
PyYAML==3.12
rcssmin==1.0.6
reno==2.5.0
repoze.lru==0.7
requests==2.14.2
requestsexceptions==1.2.0
@ -110,8 +108,6 @@ semantic-version==2.3.1
simplejson==3.5.1
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.2
sphinxcontrib-websupport==1.0.1
statsd==3.2.1
stevedore==1.20.0
tenacity==3.2.1

10
releasenotes/source/conf.py
View File

@ -43,10 +43,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/neutron-vpnaas-dashboard'
bug_project = 'neutron-vpnaas-dashboard'
bug_tag = 'doc'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
openstackdocs_repo_name = 'openstack/neutron-vpnaas-dashboard'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'neutron-vpnaas-dashboard'
openstackdocs_bug_tag = 'doc'
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -100,7 +100,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 = []