diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-18 22:08:18 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-18 22:09:17 +0200 |
| commit | 85ef7b7108ffe491749b52f9ffccade1e2a66164 (patch) | |
| tree | 99d056ceb60266b23c8b7575d29cd3c49a1124ca /doc | |
| parent | 6d9d2e62915edcf6a5796984012ce17e1d87f1c5 (diff) | |
| download | python-neutronclient-85ef7b7108ffe491749b52f9ffccade1e2a66164.tar.gz | |
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.
Set openstackdocs_auto_name to use 'project' as name.
Depends-On: https://review.opendev.org/728938
Change-Id: I9e1dcc5c8861ac9d800ed7425b3e3193dd13c546
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 6 | ||||
| -rw-r--r-- | doc/source/conf.py | 7 |
2 files changed, 7 insertions, 6 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 8dc65ed..76ce5cd 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.32.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=2.2.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 4b43005..e3e269e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -13,9 +13,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/python-neutronclient' -bug_project = 'python-neutronclient' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/python-neutronclient' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'python-neutronclient' +openstackdocs_bug_tag = 'doc' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] |