diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-18 22:28:48 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-20 21:54:12 +0200 |
| commit | 709dfd9c214218d69a9278d0a12f09af5b4fdff2 (patch) | |
| tree | db9924c2606ac0cd3c7e0e7cd26378b0a07ab668 /doc/source | |
| parent | f6ee42cd32833bf7484cbf18eab9ed110a5e9782 (diff) | |
| download | python-openstackclient-709dfd9c214218d69a9278d0a12f09af5b4fdff2.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
* 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
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/conf.py | 14 |
1 files changed, 5 insertions, 9 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 4de95fbb..2216ddd7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 |