summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Jaeger <jaegerandi@gmail.com>2017-07-02 07:32:22 +0000
committerAndreas Jaeger <aj@suse.com>2017-07-02 10:56:09 +0200
commit7aa600e42f1c6464152cdcd7b21f6f26065e1e03 (patch)
tree31c825f3490a2b2a6a3a13a1f50df35a0f6afd40
parent66d45fc53d8773b85eb3239aca53bff01aca939e (diff)
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
Notes
Notes (review): Code-Review+2: Major Hayden <major@mhtx.net> Code-Review+2: Jesse Pretorius (odyssey4me) <jesse.pretorius@rackspace.co.uk> Workflow+1: Jesse Pretorius (odyssey4me) <jesse.pretorius@rackspace.co.uk> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 03 Jul 2017 12:09:11 +0000 Reviewed-on: https://review.openstack.org/479591 Project: openstack/monitorstack Branch: refs/heads/master
-rw-r--r--doc/source/conf.py16
-rw-r--r--doc/source/develop.rst4
-rw-r--r--releasenotes/source/conf.py9
-rw-r--r--test-requirements.txt2
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
45# ones. 45# ones.
46extensions = [ 46extensions = [
47 'sphinx.ext.autodoc', 47 'sphinx.ext.autodoc',
48 'openstackdocstheme', 48 'oslosphinx',
49 'sphinxmark' 49 # Disabled, does not build
50 # 'sphinxmark'
50] 51]
51 52
52# Add any paths that contain templates here, relative to this directory. 53# Add any paths that contain templates here, relative to this directory.
@@ -121,22 +122,13 @@ todo_include_todos = False
121# The theme to use for HTML and HTML Help pages. See the documentation for 122# The theme to use for HTML and HTML Help pages. See the documentation for
122# a list of builtin themes. 123# a list of builtin themes.
123# 124#
124html_theme = 'openstackdocs' 125html_theme = 'default'
125 126
126# Theme options are theme-specific and customize the look and feel of a theme 127# Theme options are theme-specific and customize the look and feel of a theme
127# further. For a list of options available for each theme, see the 128# further. For a list of options available for each theme, see the
128# documentation. 129# documentation.
129html_theme_options = {
130 "display_toc": False
131}
132 130
133# Add any paths that contain custom themes here, relative to this directory. 131# Add any paths that contain custom themes here, relative to this directory.
134# html_theme_path = ["."]
135
136# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
137# using the given strftime format.
138# html_last_updated_fmt = '%b %d, %Y'
139html_last_updated_fmt = '%Y-%m-%d %H:%M'
140 132
141# -- Options for HTMLHelp output ------------------------------------------ 133# -- Options for HTMLHelp output ------------------------------------------
142 134
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
23--------------- 23---------------
24 24
25Add tests in the ``tests`` directory and follow the ``uptime`` example. Here 25Add tests in the ``tests`` directory and follow the ``uptime`` example. Here
26are the contents of ``tests/test_plugin_uptime.py`` as an example: 26are the contents of ``tests/int/test_plugin_uptime.py`` as an example:
27 27
28.. literalinclude:: ../../tests/test_plugin_uptime.py 28.. literalinclude:: ../../tests/int/test_plugin_uptime.py
29 29
30Running tests 30Running tests
31------------- 31-------------
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
44# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 44# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
45# ones. 45# ones.
46extensions = [ 46extensions = [
47 'openstackdocstheme', 47 'oslosphinx',
48 'reno.sphinxext', 48 'reno.sphinxext',
49] 49]
50 50
@@ -120,7 +120,7 @@ todo_include_todos = False
120# The theme to use for HTML and HTML Help pages. See the documentation for 120# The theme to use for HTML and HTML Help pages. See the documentation for
121# a list of builtin themes. 121# a list of builtin themes.
122# 122#
123html_theme = 'openstackdocs' 123html_theme = 'default'
124 124
125# Theme options are theme-specific and customize the look and feel of a theme 125# Theme options are theme-specific and customize the look and feel of a theme
126# further. For a list of options available for each theme, see the 126# further. For a list of options available for each theme, see the
@@ -129,11 +129,6 @@ html_theme = 'openstackdocs'
129# html_theme_options = {} 129# html_theme_options = {}
130 130
131# Add any paths that contain custom themes here, relative to this directory. 131# Add any paths that contain custom themes here, relative to this directory.
132# html_theme_path = []
133
134# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
135# using the given strftime format.
136html_last_updated_fmt = '%Y-%m-%d %H:%M'
137 132
138# -- Options for HTMLHelp output ------------------------------------------ 133# -- Options for HTMLHelp output ------------------------------------------
139 134
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
9 9
10# this is required for the docs build jobs 10# this is required for the docs build jobs
11sphinx>=1.6.2 # BSD 11sphinx>=1.6.2 # BSD
12openstackdocstheme>=1.5.0 # Apache-2.0 12oslosphinx>=4.7.0 # Apache-2.0
13doc8 # Apache-2.0 13doc8 # Apache-2.0
14reno>=1.8.0 # Apache-2.0 14reno>=1.8.0 # Apache-2.0
15sphinxmark>=0.1.14 # Apache-2.0 15sphinxmark>=0.1.14 # Apache-2.0