From 7aa600e42f1c6464152cdcd7b21f6f26065e1e03 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 2 Jul 2017 07:32:22 +0000 Subject: [PATCH] Revert "Switch from oslosphinx to openstackdocstheme" openstackdocstheme is only for Official OpenStack projects, see https://docs.openstack.org/openstackdocstheme/latest/ this repo is not an official project under governance. This reverts commit 66d45fc53d8773b85eb3239aca53bff01aca939e. Fix build problems: * Fix wrong include path * Disable sphinxmark Change-Id: I83e91d12e82a8cf703f4b09c7d315edbb9878bd9 --- doc/source/conf.py | 16 ++++------------ doc/source/develop.rst | 4 ++-- releasenotes/source/conf.py | 9 ++------- test-requirements.txt | 2 +- 4 files changed, 9 insertions(+), 22 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index a9c5e4b..0a74965 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -45,8 +45,9 @@ import pbr.version # ones. extensions = [ 'sphinx.ext.autodoc', - 'openstackdocstheme', - 'sphinxmark' + 'oslosphinx', + # Disabled, does not build + # 'sphinxmark' ] # Add any paths that contain templates here, relative to this directory. @@ -121,22 +122,13 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'openstackdocs' +html_theme = 'default' # 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 # documentation. -html_theme_options = { - "display_toc": False -} # Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = ["."] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' -html_last_updated_fmt = '%Y-%m-%d %H:%M' # -- Options for HTMLHelp output ------------------------------------------ diff --git a/doc/source/develop.rst b/doc/source/develop.rst index 9794571..54525f0 100644 --- a/doc/source/develop.rst +++ b/doc/source/develop.rst @@ -23,9 +23,9 @@ Testing plugins --------------- Add tests in the ``tests`` directory and follow the ``uptime`` example. Here -are the contents of ``tests/test_plugin_uptime.py`` as an example: +are the contents of ``tests/int/test_plugin_uptime.py`` as an example: -.. literalinclude:: ../../tests/test_plugin_uptime.py +.. literalinclude:: ../../tests/int/test_plugin_uptime.py Running tests ------------- diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 5b4a8ea..30240fc 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -44,7 +44,7 @@ import pbr.version # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'openstackdocstheme', + 'oslosphinx', 'reno.sphinxext', ] @@ -120,7 +120,7 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'openstackdocs' +html_theme = 'default' # 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 @@ -129,11 +129,6 @@ html_theme = 'openstackdocs' # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%Y-%m-%d %H:%M' # -- Options for HTMLHelp output ------------------------------------------ diff --git a/test-requirements.txt b/test-requirements.txt index 87e85cf..4f9dec0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,7 +9,7 @@ mock>=2.0 # BSD # this is required for the docs build jobs sphinx>=1.6.2 # BSD -openstackdocstheme>=1.5.0 # Apache-2.0 +oslosphinx>=4.7.0 # Apache-2.0 doc8 # Apache-2.0 reno>=1.8.0 # Apache-2.0 sphinxmark>=0.1.14 # Apache-2.0