openstack
/
python-openstackclient
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
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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_auto_name to use 'project' 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.

Depends-On: https://review.opendev.org/729744
Change-Id: Id3989cabdbf2204821531b00149aa0f1cb8a4955
This commit is contained in:
Andreas Jaeger 2020-05-18 22:28:48 +02:00
parent f6ee42cd32
commit 709dfd9c21
3 changed files with 12 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,9 +1,9 @@
# 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.23.2 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.5 # 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
# redirect tests in docs

14
doc/source/conf.py
View File

@ -29,11 +29,12 @@ extensions = ['sphinx.ext.autodoc',
]
# openstackdocstheme options
repository_name = 'openstack/python-openstackclient'
use_storyboard = True
openstackdocs_repo_name = 'openstack/python-openstackclient'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False
# Add project 'foo' to this list to enable the :foo-doc: role
openstack_projects = [
openstackdocs_projects = [
'neutron',
]
@ -83,7 +84,7 @@ exclude_patterns = ['**tests**']
#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 = ['openstackclient.']
@ -126,11 +127,6 @@ html_theme = 'openstackdocs'
# 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'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

12
releasenotes/source/conf.py
View File

@ -44,8 +44,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/python-openstackclient'
use_storyboard = True
openstackdocs_repo_name = 'openstack/python-openstackclient'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False
# Set aliases for extlinks
# * lpbug - generic Launchpad bug :lpbug:`123456`
@ -118,7 +119,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 = []
@ -169,11 +170,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
# 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'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True