openstack
/
python-ironic-inspector-client
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions 

Switch to openstackdocstheme 2.2.0 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.

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.

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.

Depends-On: https://review.opendev.org/728938
Change-Id: I0f59a6eb8318b9ae65c57dba1012bbded5e7186b
This commit is contained in:
Andreas Jaeger 2020-05-18 21:50:12 +02:00
parent c854837a02
commit 1278d61a71
3 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,5 +1,5 @@
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=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.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinxcontrib-apidoc>=0.2.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

5
doc/source/conf.py
View File

@ -11,8 +11,9 @@ extensions = ['sphinxcontrib.apidoc',
'openstackdocstheme',
]
repository_name = 'openstack/python-ironic-inspector-client'
use_storyboard = True
openstackdocs_repo_name = 'openstack/python-ironic-inspector-client'
openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
wsme_protocols = ['restjson']

5
lower-constraints.txt
View File

@ -39,7 +39,6 @@ msgpack-python==0.4.0
munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==1.20.0
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@ -67,7 +66,6 @@ python-novaclient==9.1.0
python-openstackclient==3.12.0
pytz==2013.6
PyYAML==3.12
reno==2.5.0
requests==2.14.2
requests-mock==1.2.0
requestsexceptions==1.2.0
@ -75,9 +73,6 @@ restructuredtext-lint==1.1.1
rfc3986==0.3.1
simplejson==3.5.1
snowballstemmer==1.2.1
Sphinx==1.6.2
sphinxcontrib-svg2pdfconverter==0.1.0
sphinxcontrib-websupport==1.0.1
stevedore==1.20.0
testtools==2.2.0
traceback2==1.4.0