switch to openstackdocstheme
Also fix warnings Change-Id: I0ffd8140ec98233b54dacb045989c976e03db355
This commit is contained in:
parent
818420c091
commit
9d558be065
12
README.rst
12
README.rst
|
@ -15,22 +15,26 @@ Murano package validator tool
|
||||||
|
|
||||||
After checking out tool from repository easiest method to run tool is to run
|
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
|
tox -e venv -- murano-pkg-check -h
|
||||||
|
|
||||||
This command will display help for murano-pkg-validator
|
This command will display help for murano-pkg-validator
|
||||||
|
|
||||||
If you installed it from PYPI you can use:
|
If you installed it from PYPI you can use:
|
||||||
.. code-block:: shell
|
.. code-block:: console
|
||||||
|
|
||||||
murano-pkg-check -h
|
murano-pkg-check -h
|
||||||
|
|
||||||
To run validator in directory apache-app just run:
|
To run validator in directory apache-app just run:
|
||||||
.. code-block:: shell
|
.. code-block:: console
|
||||||
|
|
||||||
murano-pkg-check apache-app
|
murano-pkg-check apache-app
|
||||||
|
|
||||||
It will print all errors there are on package.
|
It will print all errors there are on package.
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: console
|
||||||
|
|
||||||
murano-pkg-check --discovery murano-apps
|
murano-pkg-check --discovery murano-apps
|
||||||
|
|
||||||
Will search for all packages under directory `murano-apps`. It will print all
|
Will search for all packages under directory `murano-apps`. It will print all
|
||||||
|
|
|
@ -22,8 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
#'sphinx.ext.intersphinx',
|
'openstackdocstheme'
|
||||||
'oslosphinx'
|
|
||||||
]
|
]
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
|
@ -57,6 +56,15 @@ pygments_style = 'sphinx'
|
||||||
# html_theme_path = ["."]
|
# html_theme_path = ["."]
|
||||||
# html_theme = '_theme'
|
# html_theme = '_theme'
|
||||||
# html_static_path = ['static']
|
# 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.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = '%sdoc' % project
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
|
|
@ -38,7 +38,7 @@
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'oslosphinx',
|
'openstackdocstheme',
|
||||||
'reno.sphinxext',
|
'reno.sphinxext',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -111,7 +111,15 @@ pygments_style = 'sphinx'
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# 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
|
# 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
|
# further. For a list of options available for each theme, see the
|
||||||
|
|
|
@ -7,7 +7,7 @@ hacking<0.12,>=0.11.0 # Apache-2.0
|
||||||
coverage!=4.4,>=4.0 # Apache-2.0
|
coverage!=4.4,>=4.0 # Apache-2.0
|
||||||
python-subunit>=0.0.18 # Apache-2.0/BSD
|
python-subunit>=0.0.18 # Apache-2.0/BSD
|
||||||
sphinx>=1.6.2 # 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
|
oslotest>=1.10.0 # Apache-2.0
|
||||||
testrepository>=0.0.18 # Apache-2.0/BSD
|
testrepository>=0.0.18 # Apache-2.0/BSD
|
||||||
testscenarios>=0.4 # Apache-2.0/BSD
|
testscenarios>=0.4 # Apache-2.0/BSD
|
||||||
|
|
Loading…
Reference in New Issue