diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-18 21:40:41 +0200 |
|---|---|---|
| committer | Andreas Jaeger <jaegerandi@gmail.com> | 2020-05-22 17:23:12 +0000 |
| commit | de178ac4382716cc93022be06b93697936e816fc (patch) | |
| tree | 6f0bdf779168285d7d8fd3e671b5b0673bca3988 /doc | |
| parent | 56186d6d5aa1a0c8fde99eeb535a650b0495925d (diff) | |
| download | python-glanceclient-3.2.0.tar.gz | |
Switch to newer openstackdocstheme and reno versions3.2.0
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.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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.
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: Ie4aec288c74b9bd8d8d117f4bc2e0282cea4db90
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 6 | ||||
| -rw-r--r-- | doc/source/conf.py | 13 |
2 files changed, 7 insertions, 12 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index e8ba0fa..97c1879 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,7 +1,7 @@ # 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.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 # 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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 74d6595..bfe9b56 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,7 +16,6 @@ import os import sys -import openstackdocstheme sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) @@ -39,9 +38,9 @@ apidoc_excluded_paths = [ apidoc_separate_modules = True # openstackdocstheme options -repository_name = 'openstack/python-glanceclient' -bug_project = 'python-glanceclient' -bug_tag = '' +openstackdocs_repo_name = 'openstack/python-glanceclient' +openstackdocs_bug_project = 'python-glanceclient' +openstackdocs_bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -68,7 +67,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- @@ -77,10 +76,6 @@ pygments_style = 'sphinx' #html_theme = 'nature' html_theme = 'openstackdocs' -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = ['_theme'] -html_theme_path = [openstackdocstheme.get_html_theme_path()] - # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project |