diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-15 20:15:19 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-20 21:44:42 +0200 |
| commit | 30199f4f94d4ce94a445b6daf31067b187416798 (patch) | |
| tree | ed1a92e7414d2461a16b3a568116bfcd84606a22 | |
| parent | ccd2d0ee57ff78bbb6ed67b8b56c737e314c4484 (diff) | |
| download | python-keystoneclient-30199f4f94d4ce94a445b6daf31067b187416798.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
* 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.
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.
Depends-On: https://review.opendev.org/729744
Change-Id: I311a5daa382dfca07e618eb6cbb3f44bd0502b02
| -rw-r--r-- | doc/requirements.txt | 6 | ||||
| -rw-r--r-- | doc/source/conf.py | 9 | ||||
| -rw-r--r-- | releasenotes/source/conf.py | 8 |
3 files changed, 12 insertions, 11 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 1da2c50..b7e4e97 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,9 +3,9 @@ # process, which may cause wedges in the gate later. # These are needed for docs generation -openstackdocstheme>=1.20.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 lxml!=3.7.0,>=3.4.1 # BSD fixtures>=3.0.0 # Apache-2.0/BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 1dd272a..e74410d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -84,7 +84,7 @@ add_module_names = True #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['keystoneclient.'] @@ -227,6 +227,7 @@ intersphinx_mapping = { } # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/python-keystoneclient' -bug_project = 'python-keystoneclient' -bug_tag = '' +openstackdocs_repo_name = 'openstack/python-keystoneclient' +openstackdocs_bug_project = 'python-keystoneclient' +openstackdocs_bug_tag = '' +openstackdocs_pdf_link = True diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index b06cddf..dc65fbe 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -92,7 +92,7 @@ exclude_patterns = [] # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -257,6 +257,6 @@ texinfo_documents = [ locale_dirs = ['locale/'] # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/python-keystoneclient' -bug_project = 'python-keystoneclient' -bug_tag = '' +openstackdocs_repo_name = 'openstack/python-keystoneclient' +openstackdocs_bug_project = 'python-keystoneclient' +openstackdocs_bug_tag = '' |