Fix Zun-tempest-plugin's documentation
Change-Id: Iebb6f1604a0b02919ad7419f42b4ecab47486021
This commit is contained in:
parent
23ae1b0f3a
commit
c797709736
@ -13,10 +13,10 @@ This directory contains Tempest tests to cover the Zun project, as well
|
|||||||
as a plugin to automatically load these tests into tempest.
|
as a plugin to automatically load these tests into tempest.
|
||||||
|
|
||||||
See the Tempest plugin docs for information on using it:
|
See the Tempest plugin docs for information on using it:
|
||||||
https://docs.openstack.org/developer/tempest/plugin.html#using-plugins
|
https://docs.openstack.org/tempest/latest/#using-plugins
|
||||||
|
|
||||||
* Free software: Apache license
|
* Free software: Apache license
|
||||||
* Documentation: https://docs.openstack.org/developer/zun-tempest-plugin
|
* Documentation: https://docs.openstack.org/zun-tempest-plugin/latest
|
||||||
* Source: https://git.openstack.org/cgit/openstack/zun-tempest-plugin
|
* Source: https://git.openstack.org/cgit/openstack/zun-tempest-plugin
|
||||||
* Bugs: https://bugs.launchpad.net/zun
|
* Bugs: https://bugs.launchpad.net/zun
|
||||||
|
|
||||||
|
@ -37,11 +37,11 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'zun_tempest_plugin'
|
project = u'zun-tempest-plugin'
|
||||||
copyright = u'2017, OpenStack Developers'
|
copyright = u'2017, OpenStack Developers'
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/zun_tempest_plugin'
|
repository_name = 'openstack/zun-tempest-plugin'
|
||||||
bug_project = 'zun'
|
bug_project = 'zun'
|
||||||
bug_tag = ''
|
bug_tag = ''
|
||||||
|
|
||||||
@ -67,6 +67,9 @@ html_theme = 'openstackdocs'
|
|||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = '%sdoc' % project
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
|
||||||
|
# Must set this variable to include year, month, day, hours, and minutes.
|
||||||
|
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass
|
# (source start file, target name, title, author, documentclass
|
||||||
# [howto/manual]).
|
# [howto/manual]).
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
==================================================
|
==================================================
|
||||||
Welcome to the documentation of zun_tempest_plugin
|
Welcome to the documentation of Zun tempest plugin
|
||||||
==================================================
|
==================================================
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
@ -8,3 +8,4 @@ sphinx>=1.6.2 # BSD
|
|||||||
openstackdocstheme>=1.11.0 # Apache-2.0
|
openstackdocstheme>=1.11.0 # Apache-2.0
|
||||||
# releasenotes
|
# releasenotes
|
||||||
reno>=1.8.0 # Apache-2.0
|
reno>=1.8.0 # Apache-2.0
|
||||||
|
doc8>=0.6.0 # Apache-2.0
|
||||||
|
4
tox.ini
4
tox.ini
@ -22,7 +22,9 @@ commands = {posargs}
|
|||||||
commands = python setup.py test --coverage --testr-args='{posargs}'
|
commands = python setup.py test --coverage --testr-args='{posargs}'
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands = python setup.py build_sphinx
|
commands =
|
||||||
|
doc8 -e .rst doc/source/ CONTRIBUTING.rst HACKING.rst README.rst
|
||||||
|
python setup.py build_sphinx
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
commands =
|
commands =
|
||||||
|
Loading…
x
Reference in New Issue
Block a user