diff options
author | Andreas Jaeger <aj@suse.com> | 2020-05-31 20:34:11 +0200 |
---|---|---|
committer | Andreas Jaeger <aj@suse.com> | 2020-05-31 20:37:45 +0200 |
commit | 82a708b09f944708a770e8c5ffae5ea98848ed46 (patch) | |
tree | d462cf2f11eaecc80c0b109ba119b181acdd1ade | |
parent | aa10eb7bcbb96d78ac923735db0753472ee059a3 (diff) | |
download | os-client-config-82a708b09f944708a770e8c5ffae5ea98848ed46.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.
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: I9b21866eee164c1c14d0e4333e842bd6fefcb820
-rw-r--r-- | doc/requirements.txt | 6 | ||||
-rwxr-xr-x | doc/source/conf.py | 12 | ||||
-rw-r--r-- | releasenotes/source/conf.py | 13 |
3 files changed, 14 insertions, 17 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index bd99db7..6f12b34 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,6 +2,6 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. docutils>=0.11 # OSI-Approved Open Source, Public Domain -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index cbd9888..69304fc 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -15,8 +15,6 @@ import os import sys -import openstackdocstheme - sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- @@ -30,10 +28,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/os-client-config' -bug_project = 'os-client-config' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/os-client-config' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -57,7 +54,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 -------------------------------------------------- @@ -67,7 +64,6 @@ pygments_style = 'sphinx' # html_theme = '_theme' # html_static_path = ['static'] html_theme = 'openstackdocs' -html_theme_path = [openstackdocstheme.get_html_theme_path()] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 776088d..7ead119 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -21,13 +21,13 @@ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' -import openstackdocstheme # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'reno.sphinxext', + 'openstackdocstheme' ] # Add any paths that contain templates here, relative to this directory. @@ -46,6 +46,11 @@ master_doc = 'index' project = u'os-client-config Release Notes' copyright = u'2015, os-client-config developers' +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/os-client-config' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True + # Release notes do not need a version in the title, they span # multiple versions. # The short X.Y version. @@ -83,7 +88,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 = [] @@ -103,10 +108,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 |