From 9c13fc55488f3300d3b131a306e9e341ff730ba0 Mon Sep 17 00:00:00 2001 From: Ben Nemec Date: Thu, 30 May 2019 19:03:36 +0000 Subject: [PATCH] Remove oslosphinx It has been retired and we don't want to use it in new projects. Switch to openstackdocstheme for our Sphinx theme. Change-Id: Ia41525f1b712e318054d3179d2cd6b0dab39912c --- oslo.{{cookiecutter.module_name}}/doc/source/conf.py | 10 ++++------ .../test-requirements.txt | 5 +++-- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/oslo.{{cookiecutter.module_name}}/doc/source/conf.py b/oslo.{{cookiecutter.module_name}}/doc/source/conf.py index e6e64d5..6ccea69 100755 --- a/oslo.{{cookiecutter.module_name}}/doc/source/conf.py +++ b/oslo.{{cookiecutter.module_name}}/doc/source/conf.py @@ -21,11 +21,11 @@ sys.path.insert(0, os.path.abspath('../..')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ - 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme', ] +repository_name = 'openstack/oslo.{{cookiecutter.module_name}}' + # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -54,9 +54,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -# 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 diff --git a/oslo.{{cookiecutter.module_name}}/test-requirements.txt b/oslo.{{cookiecutter.module_name}}/test-requirements.txt index 88ac441..43716de 100644 --- a/oslo.{{cookiecutter.module_name}}/test-requirements.txt +++ b/oslo.{{cookiecutter.module_name}}/test-requirements.txt @@ -6,5 +6,6 @@ hacking<0.11,>=0.10.0 oslotest>=1.5.1 # These are needed for docs generation -oslosphinx>=2.5.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +openstackdocstheme>=1.20.0