summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzhurong <aaronzhu1121@gmail.com>2017-07-07 16:02:13 +0800
committerKirill Zaitsev <k.zaitsev@me.com>2017-07-07 15:54:45 +0300
commit9d558be06541b03100cb055c55490d45f2a59074 (patch)
tree82b8131397fe7d3a49f1623570757c780440858a
parent818420c091962d7ffb24b3dd45b2151dc3db8b1e (diff)
switch to openstackdocstheme
Also fix warnings Change-Id: I0ffd8140ec98233b54dacb045989c976e03db355
Notes
Notes (review): Code-Review+2: Kirill Zaitsev <k.zaitsev@me.com> Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Workflow+1: Felipe Monteiro <felipe.monteiro@att.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Tue, 11 Jul 2017 00:24:52 +0000 Reviewed-on: https://review.openstack.org/481488 Project: openstack/murano-pkg-check Branch: refs/heads/master
-rw-r--r--README.rst12
-rwxr-xr-xdoc/source/conf.py12
-rw-r--r--releasenotes/source/conf.py12
-rw-r--r--test-requirements.txt2
4 files changed, 29 insertions, 9 deletions
diff --git a/README.rst b/README.rst
index 32925c3..3811d80 100644
--- a/README.rst
+++ b/README.rst
@@ -15,22 +15,26 @@ Murano package validator tool
15 15
16After checking out tool from repository easiest method to run tool is to run 16After checking out tool from repository easiest method to run tool is to run
17 17
18.. code-block:: shell 18.. code-block:: console
19
19 tox -e venv -- murano-pkg-check -h 20 tox -e venv -- murano-pkg-check -h
20 21
21This command will display help for murano-pkg-validator 22This command will display help for murano-pkg-validator
22 23
23If you installed it from PYPI you can use: 24If you installed it from PYPI you can use:
24.. code-block:: shell 25.. code-block:: console
26
25 murano-pkg-check -h 27 murano-pkg-check -h
26 28
27To run validator in directory apache-app just run: 29To run validator in directory apache-app just run:
28.. code-block:: shell 30.. code-block:: console
31
29 murano-pkg-check apache-app 32 murano-pkg-check apache-app
30 33
31It will print all errors there are on package. 34It will print all errors there are on package.
32 35
33.. code-block:: shell 36.. code-block:: console
37
34 murano-pkg-check --discovery murano-apps 38 murano-pkg-check --discovery murano-apps
35 39
36Will search for all packages under directory `murano-apps`. It will print all 40Will search for all packages under directory `murano-apps`. It will print all
diff --git a/doc/source/conf.py b/doc/source/conf.py
index bad5982..4e94e59 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,8 +22,7 @@ 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'
27] 26]
28 27
29# autodoc generation is a bit aggressive and a nuisance when doing heavy 28# autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -57,6 +56,15 @@ pygments_style = 'sphinx'
57# html_theme_path = ["."] 56# html_theme_path = ["."]
58# html_theme = '_theme' 57# html_theme = '_theme'
59# html_static_path = ['static'] 58# html_static_path = ['static']
59html_theme = 'openstackdocs'
60
61# openstackdocstheme options
62repository_name = 'openstack/murano-pkg-check'
63bug_project = 'murano-pkg-check'
64bug_tag = ''
65
66# Must set this variable to include year, month, day, hours, and minutes.
67html_last_updated_fmt = '%Y-%m-%d %H:%M'
60 68
61# Output file base name for HTML help builder. 69# Output file base name for HTML help builder.
62htmlhelp_basename = '%sdoc' % project 70htmlhelp_basename = '%sdoc' % project
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 0cd0d57..4c813d8 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -38,7 +38,7 @@
38# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 38# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39# ones. 39# ones.
40extensions = [ 40extensions = [
41 'oslosphinx', 41 'openstackdocstheme',
42 'reno.sphinxext', 42 'reno.sphinxext',
43] 43]
44 44
@@ -111,7 +111,15 @@ pygments_style = 'sphinx'
111 111
112# The theme to use for HTML and HTML Help pages. See the documentation for 112# The theme to use for HTML and HTML Help pages. See the documentation for
113# a list of builtin themes. 113# a list of builtin themes.
114html_theme = 'default' 114html_theme = 'openstackdocs'
115
116# openstackdocstheme options
117repository_name = 'openstack/murano-pkg-check'
118bug_project = 'murano-pkg-check'
119bug_tag = ''
120
121# Must set this variable to include year, month, day, hours, and minutes.
122html_last_updated_fmt = '%Y-%m-%d %H:%M'
115 123
116# Theme options are theme-specific and customize the look and feel of a theme 124# Theme options are theme-specific and customize the look and feel of a theme
117# further. For a list of options available for each theme, see the 125# further. For a list of options available for each theme, see the
diff --git a/test-requirements.txt b/test-requirements.txt
index 114333f..46fb2da 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -7,7 +7,7 @@ hacking<0.12,>=0.11.0 # Apache-2.0
7coverage!=4.4,>=4.0 # Apache-2.0 7coverage!=4.4,>=4.0 # Apache-2.0
8python-subunit>=0.0.18 # Apache-2.0/BSD 8python-subunit>=0.0.18 # Apache-2.0/BSD
9sphinx>=1.6.2 # BSD 9sphinx>=1.6.2 # BSD
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
12testrepository>=0.0.18 # Apache-2.0/BSD 12testrepository>=0.0.18 # Apache-2.0/BSD
13testscenarios>=0.4 # Apache-2.0/BSD 13testscenarios>=0.4 # Apache-2.0/BSD