From c20bce5e10a15953c5131b3889bfd1755ad54c22 Mon Sep 17 00:00:00 2001 From: Thomas Bechtold Date: Thu, 4 Jan 2018 08:09:03 +0100 Subject: [PATCH] Use openstackdocstheme for docs and release notes Replace the usage of oslosphinx with openstackdocstheme and follow the porting guide[1]. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Change-Id: I8199b787c05406ba3997fdfe26d2bfcd31b329b4 --- doc/source/conf.py | 8 +++++++- releasenotes/source/conf.py | 9 +++++++-- test-requirements.txt | 2 +- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index ed05ed7..1221df1 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -56,6 +56,7 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] +html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project @@ -72,3 +73,8 @@ latex_documents = [ # Example configuration for intersphinx: refer to the Python standard library. #intersphinx_mapping = {'http://docs.python.org/': None} + +# openstackdocstheme options +repository_name = 'openstack/keystone-tempest-plugin' +bug_project = 'keystone' +bug_tag = 'docs' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 23f6399..215098f 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,7 +38,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -111,7 +111,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -273,3 +273,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# openstackdocstheme options +repository_name = 'openstack/keystone-tempest-plugin' +bug_project = 'keystone' +bug_tag = 'releasenotes' diff --git a/test-requirements.txt b/test-requirements.txt index 64f3df7..b2051c9 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,7 +5,7 @@ hacking>=0.12.0,<0.13 # Apache-2.0 sphinx!=1.6.1,>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.17.0 # Apache-2.0 # releasenotes reno>=1.8.0 # Apache-2.0