From 9d558be06541b03100cb055c55490d45f2a59074 Mon Sep 17 00:00:00 2001 From: zhurong Date: Fri, 7 Jul 2017 16:02:13 +0800 Subject: [PATCH] switch to openstackdocstheme Also fix warnings Change-Id: I0ffd8140ec98233b54dacb045989c976e03db355 --- README.rst | 12 ++++++++---- doc/source/conf.py | 12 ++++++++++-- releasenotes/source/conf.py | 12 ++++++++++-- test-requirements.txt | 2 +- 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 After checking out tool from repository easiest method to run tool is to run -.. code-block:: shell +.. code-block:: console + tox -e venv -- murano-pkg-check -h This command will display help for murano-pkg-validator If you installed it from PYPI you can use: -.. code-block:: shell +.. code-block:: console + murano-pkg-check -h To run validator in directory apache-app just run: -.. code-block:: shell +.. code-block:: console + murano-pkg-check apache-app It will print all errors there are on package. -.. code-block:: shell +.. code-block:: console + murano-pkg-check --discovery murano-apps Will 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('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -57,6 +56,15 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] +html_theme = 'openstackdocs' + +# openstackdocstheme options +repository_name = 'openstack/murano-pkg-check' +bug_project = 'murano-pkg-check' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # Output file base name for HTML help builder. htmlhelp_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 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -111,7 +111,15 @@ 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' + +# openstackdocstheme options +repository_name = 'openstack/murano-pkg-check' +bug_project = 'murano-pkg-check' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # 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 114333f..46fb2da 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,7 +7,7 @@ hacking<0.12,>=0.11.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD