From a771c1e0ed405d93dde6f5eae589a5f3ecfc9fef Mon Sep 17 00:00:00 2001 From: Thomas Bechtold Date: Tue, 16 Jan 2018 07:10:33 +0100 Subject: [PATCH] Use openstackdocstheme for docs and release notes Replace the usage of oslosphinx with openstackdocstheme and follow the porting guide[1]. Also bump the used Sphinx version to the one from global-requirements. Otherwise the docs build fails. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Change-Id: I9cb15f670e312faa49d95e14c84b7f4ec72bf8e0 --- doc/source/conf.py | 8 +++++++- releasenotes/source/conf.py | 9 +++++++-- test-requirements.txt | 4 ++-- 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 54ea3e4..00743e3 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,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 @@ -57,6 +57,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 @@ -73,3 +74,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/cursive' +bug_project = 'cursive' +bug_tag = 'docs' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 4002f9a..4762be1 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 @@ -274,3 +274,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# openstackdocstheme options +repository_name = 'openstack/cursive' +bug_project = 'cursive' +bug_tag = 'docs' diff --git a/test-requirements.txt b/test-requirements.txt index 719d5c3..1a094ec 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,8 +7,8 @@ hacking<0.12,>=0.11.0 # Apache-2.0 coverage>=3.6 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD mock>=2.0.0 # BSD -sphinx!=1.3b1,<1.3,>=1.2.1 # BSD -oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 +sphinx>=1.6.2,!=1.6.6 # BSD +openstackdocstheme>=1.17.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD