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 /releasenotes | |
parent | 56186d6d5aa1a0c8fde99eeb535a650b0495925d (diff) | |
download | python-glanceclient-de178ac4382716cc93022be06b93697936e816fc.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 'releasenotes')
-rw-r--r-- | releasenotes/source/conf.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 75aab4d..d20e2f4 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -29,8 +29,6 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # sys.path.insert(0, os.path.abspath('.')) -import openstackdocstheme - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -41,6 +39,7 @@ import openstackdocstheme # ones. extensions = [ 'reno.sphinxext', + 'openstackdocstheme' ] # Add any paths that contain templates here, relative to this directory. @@ -59,6 +58,11 @@ master_doc = 'index' project = u'glanceclient Release Notes' copyright = u'2016, Glance Developers' +openstackdocs_repo_name = 'openstack/python-glanceclient' +openstackdocs_bug_project = 'python-glanceclient' +openstackdocs_bug_tag = '' +openstackdocs_auto_name = False + # Release notes are not versioned, so we don't need to set version or release version = '' release = '' @@ -93,7 +97,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 = [] @@ -113,10 +117,6 @@ html_theme = 'openstackdocs' # documentation. # html_theme_options = {} -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] -html_theme_path = [openstackdocstheme.get_html_theme_path()] - # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". # html_title = None |