diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-06-02 19:01:07 +0200 |
|---|---|---|
| committer | Tim Burke <tim.burke@gmail.com> | 2020-09-18 12:22:01 -0700 |
| commit | e367b6270c6d544312817ab31723aae54f4c234a (patch) | |
| tree | a4addac4ead69a6478bc67f5c014b6f71f5aa2f4 /doc | |
| parent | 5cb906148709ccc74ca96463fd69a5cae2381edb (diff) | |
| download | python-swiftclient-e367b6270c6d544312817ab31723aae54f4c234a.tar.gz | |
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: I4418f86c3066353d43758118865baf66d1741c79
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | doc/source/conf.py | 10 |
2 files changed, 8 insertions, 6 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 5700e3b..6894ce1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ keystoneauth1>=3.4.0 # Apache-2.0 sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0 # BSD -reno>=2.5.0 # Apache-2.0 -openstackdocstheme>=1.31.2 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 5f88f5a..8381605 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -55,6 +55,12 @@ master_doc = 'index' # General information about the project. copyright = u'2013-2016 OpenStack, LLC.' +# -- Options for openstackdocstheme ------------------------------------------- +openstackdocs_repo_name = 'openstack/python-swiftclient' +openstackdocs_bug_project = 'python-swiftclient' +openstackdocs_bug_tag = '' +openstackdocs_pdf_link = True + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -131,10 +137,6 @@ html_theme_options = {'show_other_versions': True} # 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 = '%b %d, %Y' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True |