diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-30 16:57:25 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-30 16:57:57 +0200 |
| commit | 7eb163542550bf4c6883430bc7baec293ca0a38b (patch) | |
| tree | 0917e678d9358fa4ac15a7789f9e7085f870a547 /doc | |
| parent | 4de8d3c2d6ecff85e6696821a1e6c9522688494e (diff) | |
| download | glance_store-7eb163542550bf4c6883430bc7baec293ca0a38b.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.
Disable openstackdocs_auto_name to use 'project' variable 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.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Iee357adb23ff65e453ac627eaec0b9d7ac245ba6
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 6 | ||||
| -rw-r--r-- | doc/source/conf.py | 10 |
2 files changed, 8 insertions, 8 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index f0dc045..bd5c965 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. -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 0bf9837..582d001 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,10 +25,10 @@ extensions = ['openstackdocstheme', 'sphinxcontrib.apidoc'] # openstackdocstheme options -repository_name = 'openstack/glance_store' -bug_project = 'glance-store' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/glance_store' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'glance-store' +openstackdocs_bug_tag = '' # sphinxcontrib.apidoc options apidoc_module_dir = '../../glance_store' @@ -63,7 +63,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 -------------------------------------------------- |