summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKirill Zaitsev <k.zaitsev@me.com>2017-06-29 14:02:07 +0300
committerKirill Zaitsev <k.zaitsev@me.com>2017-07-03 14:26:43 +0300
commit9872e6a36514e6ac196b773bf1121bbc77eb4148 (patch)
tree16f16f44f8d4f0c650497f3f12f3977114a9abad
parent7446bc47ae44eb03d45da5b6e458fe1272d44510 (diff)
Use openstackdocstheme over oslosphinx
This commit is part of general doc-migration effort. It replaces oslosphinx with openstackdocstheme and marks docs warnings to be treated as errors. Kuryr projects do not seem to have any docs in the openstack-manuals, so there are no docs we need to pull from that repo. However being the official project kuryr would benefit from unifying its docs with the rest of openstack projects as well as using openstackdocstheme, theme intended for official projects https://docs.openstack.org/openstackdocstheme/latest/ See https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html and https://etherpad.openstack.org/p/doc-migration-tracking for more information Change-Id: I4b854a830268beea0e463a1c75f73e8d523f3bfb
Notes
Notes (review): Code-Review+2: Berezovsky Irena <irenab.dev@gmail.com> Code-Review+2: Liping Mao <limao@cisco.com> Workflow+1: Liping Mao <limao@cisco.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Tue, 04 Jul 2017 00:56:19 +0000 Reviewed-on: https://review.openstack.org/478868 Project: openstack/kuryr Branch: refs/heads/master
-rw-r--r--README.rst2
-rw-r--r--doc/source/conf.py13
-rw-r--r--releasenotes/source/conf.py16
-rw-r--r--setup.cfg1
-rw-r--r--test-requirements.txt4
5 files changed, 25 insertions, 11 deletions
diff --git a/README.rst b/README.rst
index 450ed13..8f7a709 100644
--- a/README.rst
+++ b/README.rst
@@ -170,7 +170,7 @@ documentation. You can install Sphinx using pip.
170In addition to Sphinx you will also need the following requirements 170In addition to Sphinx you will also need the following requirements
171(not covered by `requirements.txt`):: 171(not covered by `requirements.txt`)::
172 172
173 $ pip install oslosphinx reno 'reno[sphinx]' 173 $ pip install openstackdocstheme reno 'reno[sphinx]'
174 174
175The source code of the documentation are under *doc*, you can generate the 175The source code of the documentation are under *doc*, you can generate the
176html files using the following command. If the generation succeeds,a 176html files using the following command. If the generation succeeds,a
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 111067c..8d70342 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,9 +22,8 @@ sys.path.insert(0, os.path.abspath('../..'))
22# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 22# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23extensions = [ 23extensions = [
24 'sphinx.ext.autodoc', 24 'sphinx.ext.autodoc',
25 #'sphinx.ext.intersphinx', 25 'openstackdocstheme',
26 'oslosphinx', 26 'reno.sphinxext',
27 'reno.sphinxext'
28] 27]
29 28
30# autodoc generation is a bit aggressive and a nuisance when doing heavy 29# autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -41,6 +40,12 @@ master_doc = 'index'
41project = u'kuryr' 40project = u'kuryr'
42copyright = u'2013, OpenStack Foundation' 41copyright = u'2013, OpenStack Foundation'
43 42
43# openstackdocstheme options
44repository_name = 'openstack/kuryr'
45bug_project = 'kuryr'
46bug_tag = ''
47html_last_updated_fmt = '%Y-%m-%d %H:%M'
48
44# If true, '()' will be appended to :func: etc. cross-reference text. 49# If true, '()' will be appended to :func: etc. cross-reference text.
45add_function_parentheses = True 50add_function_parentheses = True
46 51
@@ -56,7 +61,7 @@ pygments_style = 'sphinx'
56# The theme to use for HTML and HTML Help pages. Major themes that come with 61# The theme to use for HTML and HTML Help pages. Major themes that come with
57# Sphinx are currently 'default' and 'sphinxdoc'. 62# Sphinx are currently 'default' and 'sphinxdoc'.
58# html_theme_path = ["."] 63# html_theme_path = ["."]
59# html_theme = '_theme' 64html_theme = 'openstackdocs'
60# html_static_path = ['static'] 65# html_static_path = ['static']
61 66
62# Output file base name for HTML help builder. 67# Output file base name for HTML help builder.
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index b7028bf..e41dd45 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -30,8 +30,10 @@ from kuryr.lib import version as kuryr_version
30# Add any Sphinx extension module names here, as strings. They can be 30# Add any Sphinx extension module names here, as strings. They can be
31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32# ones. 32# ones.
33extensions = ['reno.sphinxext', 33extensions = [
34 'oslosphinx'] 34 'reno.sphinxext',
35 'openstackdocstheme',
36]
35 37
36# Add any paths that contain templates here, relative to this directory. 38# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates'] 39templates_path = ['_templates']
@@ -53,6 +55,12 @@ master_doc = 'index'
53project = u'kuryr' 55project = u'kuryr'
54copyright = u'2016, Kuryr developers' 56copyright = u'2016, Kuryr developers'
55 57
58# openstackdocstheme options
59repository_name = 'openstack/kuryr'
60bug_project = 'kuryr'
61bug_tag = ''
62html_last_updated_fmt = '%Y-%m-%d %H:%M'
63
56# The version info for the project you're documenting, acts as replacement for 64# The version info for the project you're documenting, acts as replacement for
57# |version| and |release|, also used in various other places throughout the 65# |version| and |release|, also used in various other places throughout the
58# built documents. 66# built documents.
@@ -120,7 +128,7 @@ todo_include_todos = False
120# The theme to use for HTML and HTML Help pages. See the documentation for 128# The theme to use for HTML and HTML Help pages. See the documentation for
121# a list of builtin themes. 129# a list of builtin themes.
122# 130#
123html_theme = 'default' 131html_theme = 'openstackdocs'
124 132
125# Theme options are theme-specific and customize the look and feel of a theme 133# 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 134# further. For a list of options available for each theme, see the
@@ -154,7 +162,7 @@ html_theme = 'default'
154# Add any paths that contain custom static files (such as style sheets) here, 162# Add any paths that contain custom static files (such as style sheets) here,
155# relative to this directory. They are copied after the builtin static files, 163# relative to this directory. They are copied after the builtin static files,
156# so a file named "default.css" will overwrite the builtin "default.css". 164# so a file named "default.css" will overwrite the builtin "default.css".
157html_static_path = ['_static'] 165# html_static_path = ['_static']
158 166
159# Add any extra paths that contain custom files (such as robots.txt or 167# Add any extra paths that contain custom files (such as robots.txt or
160# .htaccess) here, relative to this directory. These files are copied 168# .htaccess) here, relative to this directory. These files are copied
diff --git a/setup.cfg b/setup.cfg
index 1d44f1a..b613b33 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -35,6 +35,7 @@ data_files =
35source-dir = doc/source 35source-dir = doc/source
36build-dir = doc/build 36build-dir = doc/build
37all_files = 1 37all_files = 1
38warning-is-error = 1
38 39
39[upload_sphinx] 40[upload_sphinx]
40upload-dir = doc/build/html 41upload-dir = doc/build/html
diff --git a/test-requirements.txt b/test-requirements.txt
index 7058e33..7324f59 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -7,11 +7,11 @@ coverage>=4.0 # Apache-2.0
7ddt>=1.0.1 # MIT 7ddt>=1.0.1 # MIT
8hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 8hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
9os-testr>=0.8.0 # Apache-2.0 9os-testr>=0.8.0 # Apache-2.0
10oslosphinx>=4.7.0 # Apache-2.0 10openstackdocstheme>=1.11.0 # Apache-2.0
11oslotest>=1.10.0 # Apache-2.0 11oslotest>=1.10.0 # Apache-2.0
12python-subunit>=0.0.18 # Apache-2.0/BSD 12python-subunit>=0.0.18 # Apache-2.0/BSD
13reno>=1.8.0 # Apache-2.0 13reno>=1.8.0 # Apache-2.0
14sphinx>=1.5.1 # BSD 14sphinx>=1.6.2 # BSD
15testrepository>=0.0.18 # Apache-2.0/BSD 15testrepository>=0.0.18 # Apache-2.0/BSD
16testscenarios>=0.4 # Apache-2.0/BSD 16testscenarios>=0.4 # Apache-2.0/BSD
17testtools>=1.4.0 # MIT 17testtools>=1.4.0 # MIT