diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-15 21:57:09 +0200 |
|---|---|---|
| committer | Andreas Jaeger <jaegerandi@gmail.com> | 2020-05-21 13:43:00 +0000 |
| commit | a9e9de2f210df9eda2e0e8dfd8d5c75e1ede4212 (patch) | |
| tree | 4d5b1484b2e0280764d5e1e788cb31cf32dfa48e | |
| parent | 825f026448df3b3c22521dbda08cb8b5f8f5b423 (diff) | |
| download | keystonemiddleware-a9e9de2f210df9eda2e0e8dfd8d5c75e1ede4212.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.
Remove the doc requirements from lower-constraints, they are not
needed during installation.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Ic7c901ff19aa073b6e003ccb95aaf77886f20152
| -rw-r--r-- | doc/requirements.txt | 6 | ||||
| -rw-r--r-- | doc/source/conf.py | 9 | ||||
| -rw-r--r-- | lower-constraints.txt | 1 | ||||
| -rw-r--r-- | releasenotes/source/conf.py | 8 |
4 files changed, 12 insertions, 12 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index f89d55a..4f27cc1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,9 +4,9 @@ # For generating sphinx documentation doc8>=0.6.0 # Apache-2.0 -openstackdocstheme>=1.20.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD # PDF Docs diff --git a/doc/source/conf.py b/doc/source/conf.py index 4428242..4c39b3a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -107,7 +107,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 = ['keystonemiddleware.'] @@ -242,6 +242,7 @@ intersphinx_mapping = {'keystoneclient': (keystoneclient, None), } # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/keystonemiddleware' -bug_project = 'keystonemiddleware' -bug_tag = '' +openstackdocs_repo_name = 'openstack/keystonemiddleware' +openstackdocs_bug_project = 'keystonemiddleware' +openstackdocs_bug_tag = '' +openstackdocs_pdf_link = True diff --git a/lower-constraints.txt b/lower-constraints.txt index 90c49e4..8fd4ac7 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -63,7 +63,6 @@ python-mimeparse==1.6.0 python-subunit==1.2.0 pytz==2018.3 PyYAML==3.12 -reno==2.5.0 requests-mock==1.2.0 requests==2.14.2 requestsexceptions==1.4.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 1be30eb..9d399ae 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -93,7 +93,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 = [] @@ -258,6 +258,6 @@ texinfo_documents = [ locale_dirs = ['locale/'] # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/keystonemiddleware' -bug_project = 'keystonemiddleware' -bug_tag = '' +openstackdocs_repo_name = 'openstack/keystonemiddleware' +openstackdocs_bug_project = 'keystonemiddleware' +openstackdocs_bug_tag = '' |