openstack
/
python-searchlightclient
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: I6b95add07b469274ba1bf0070ba8c18b1795be41
This commit is contained in:
Andreas Jaeger 2020-05-18 22:44:04 +02:00
parent bc04322a38
commit 983cae71c6
3 changed files with 6 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
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.
openstackdocstheme>=1.30.0 # Apache-2.0
openstackdocstheme>=2.2.0 # Apache-2.0
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
sphinx>=1.8.0,!=2.1.0 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD

21
doc/source/conf.py
View File

@ -48,22 +48,13 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = 'python-searchlightclient'
copyright = 'OpenStack Contributors'
# openstackdocstheme options
repository_name = 'openstack/python-searchlightclient'
bug_project = 'python-searchlightclient'
bug_tag = ''
# 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 = 'X.Y'
# The full version, including alpha/beta/rc tags.
#release = 'X.Y.Z'
openstackdocs_repo_name = 'openstack/python-searchlightclient'
openstackdocs_pdf_link = True
openstackdocs_bug_project = 'python-searchlightclient'
openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -146,10 +137,6 @@ html_theme = 'openstackdocs'
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

3
lower-constraints.txt
View File

@ -31,7 +31,6 @@ msgpack-python==0.4.0
munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==1.18.1
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@ -62,8 +61,6 @@ requestsexceptions==1.2.0
rfc3986==0.3.1
simplejson==3.5.1
snowballstemmer==1.2.1
Sphinx==1.8.0
sphinxcontrib-websupport==1.0.1
stevedore==1.20.0
stestr==2.0.0
testrepository==0.0.18