summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-07-19 21:00:31 +0000
committerGerrit Code Review <review@openstack.org>2017-07-19 21:00:31 +0000
commit938e2e3bc9862504e63f4e5993a3dd40b3984135 (patch)
tree433b56995e7f535f7a1b91a6fa5d51be63042655
parentacc18e04c8fc0c6bdba3b50ba539534337d6f448 (diff)
parent945e155f05d3a76fa55c68c77564b136ee3f9ba1 (diff)
downloadpython-novaclient-938e2e3bc9862504e63f4e5993a3dd40b3984135.tar.gz
Merge "doc: Switch from oslosphinx to openstackdocstheme"
-rw-r--r--doc/source/conf.py18
-rw-r--r--releasenotes/source/conf.py4
-rw-r--r--test-requirements.txt2
3 files changed, 18 insertions, 6 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 19d10bde..46a7ae33 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -79,7 +79,10 @@ gen_ref("v2", "Version 2 API", sorted(get_module_names()))
# 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', 'oslosphinx']
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'openstackdocstheme',
+]
autoclass_content = 'both'
@@ -92,7 +95,10 @@ source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
-# General information about the project.
+# openstackdocstheme options
+repository_name = 'openstack/python-novaclient'
+bug_project = 'python-novaclient'
+bug_tag = 'doc'
project = 'python-novaclient'
copyright = 'OpenStack Contributors'
@@ -114,7 +120,13 @@ 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 = 'default'
+html_theme = 'openstackdocs'
+
+# -- Options for openstackdocstheme -------------------------------------------
+
+repository_name = 'openstack/python-novaclient'
+bug_project = 'python-novaclient'
+bug_tag = ''
# -- Options for manual page output ------------------------------------------
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 87606398..7a743aca 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -26,8 +26,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'oslosphinx',
'reno.sphinxext',
+ 'openstackdocstheme',
]
# Add any paths that contain templates here, relative to this directory.
@@ -100,7 +100,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
diff --git a/test-requirements.txt b/test-requirements.txt
index c8662645..44c52f1f 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -15,7 +15,7 @@ python-neutronclient>=6.3.0 # Apache-2.0
requests-mock>=1.1 # Apache-2.0
sphinx>=1.6.2 # BSD
os-client-config>=1.27.0 # Apache-2.0
-oslosphinx>=4.7.0 # Apache-2.0
+openstackdocstheme>=1.11.0 # Apache-2.0
osprofiler>=1.4.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD