openstack
/
keystonemiddleware
Code Issues Proposed changes

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
This commit is contained in:
Andreas Jaeger 2020-05-15 21:57:09 +02:00 committed by Andreas Jaeger
parent 825f026448
commit a9e9de2f21
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -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

9
doc/source/conf.py
View File

@ -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

1
lower-constraints.txt
View File

@ -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

8
releasenotes/source/conf.py
View File

@ -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 = ''