openstack/horizon
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_pdf_link to link to PDF file.

Remove docs requirements from lower-constraints, they are not installed.

For more info. please refer [1].
[1] https://review.opendev.org/728938

Change-Id: I90d064e63baa5f067f38a881eb9a556dfb435e97
This commit is contained in:
manchandavishal 2020-05-19 10:33:04 +00:00 committed by Vishal Manchanda
parent ed11d5bb2f
commit f8658d9880
4 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -5,9 +5,9 @@
# changes how packages are installed. New dependencies should be # changes how packages are installed. New dependencies should be
# added in alphabetical order, however, some dependencies may need to # added in alphabetical order, however, some dependencies may need to
# be installed in a specific order. # be installed in a specific order.
openstackdocstheme>=1.20.0 # Apache-2.0 openstackdocstheme>=2.2.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0
# The below is rewquired to build testing module reference # The below is rewquired to build testing module reference

7
doc/source/conf.py
View File

@ -72,9 +72,10 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/horizon' openstackdocs_repo__name = 'openstack/horizon'
bug_project = 'horizon' openstackdocs_repo_bug_project = 'horizon'
bug_tag = 'documentation' openstackdocs_bug_tag = 'documentation'
openstackdocs_pdf_link = True
# Set aliases for extlinks # Set aliases for extlinks
# - generic launchpad bug - [:bug:`12345`] # - generic launchpad bug - [:bug:`12345`]

5
lower-constraints.txt
View File

@ -50,7 +50,6 @@ munch==2.1.0
netaddr==0.7.18 netaddr==0.7.18
netifaces==0.10.4 netifaces==0.10.4
nodeenv==0.9.4 nodeenv==0.9.4
openstackdocstheme==1.20.0
openstacksdk==0.11.2 openstacksdk==0.11.2
os-client-config==1.28.0 os-client-config==1.28.0
os-service-types==1.2.0 os-service-types==1.2.0
@ -101,7 +100,7 @@ python-swiftclient==3.2.0
pytz==2013.6 pytz==2013.6
PyYAML==3.12 PyYAML==3.12
rcssmin==1.0.6 rcssmin==1.0.6
reno==2.5.0 reno==3.1.0
repoze.lru==0.7 repoze.lru==0.7
requests==2.14.2 requests==2.14.2
requestsexceptions==1.2.0 requestsexceptions==1.2.0
@ -114,8 +113,6 @@ semantic-version==2.3.1
simplejson==3.5.1 simplejson==3.5.1
six==1.10.0 six==1.10.0
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.6.5
sphinxcontrib-websupport==1.0.1
statsd==3.2.1 statsd==3.2.1
stevedore==1.20.0 stevedore==1.20.0
tenacity==3.2.1 tenacity==3.2.1

6
releasenotes/source/conf.py
View File

@ -44,9 +44,9 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/horizon' openstackdocs_repo_name = 'openstack/horizon'
bug_project = 'horizon' openstackdocs_bug_project = 'horizon'
bug_tag = 'documentation' openstackdocs_bug_tag = 'documentation'
# Set aliases for extlinks # Set aliases for extlinks
# - generic launchpad bug - [:bug:`12345`] # - generic launchpad bug - [:bug:`12345`]