Add support for new doc PTI jobs
Implement optional cleanup to support the new PTI jobs for documentation which won't use tox anymore. Docs tox environment will still available for developers but it is no loger used in the gate to construct the documentation. See http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: Ib26b711365389c59658f9d7f6cafd5acb736dfce
This commit is contained in:
parent
2619ebac4d
commit
d1bfd90593
@ -1,6 +1,6 @@
|
|||||||
========================
|
===============
|
||||||
RefStack Client
|
RefStack Client
|
||||||
========================
|
===============
|
||||||
|
|
||||||
RefStack-client team and repository tags
|
RefStack-client team and repository tags
|
||||||
########################################
|
########################################
|
||||||
|
2
doc/requirements.txt
Normal file
2
doc/requirements.txt
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
sphinx>=1.6.2 # BSD
|
||||||
|
openstackdocstheme>=1.11.0 # Apache-2.0
|
@ -1,6 +1,6 @@
|
|||||||
=======================
|
==============================
|
||||||
Refstack-Client Specifications
|
Refstack-Client Specifications
|
||||||
=======================
|
==============================
|
||||||
|
|
||||||
This folder is used to hold design specifications for additions
|
This folder is used to hold design specifications for additions
|
||||||
to the refstack-client project. Reviews of the specs are done in gerrit, using a
|
to the refstack-client project. Reviews of the specs are done in gerrit, using a
|
||||||
|
@ -132,6 +132,7 @@ installation.
|
|||||||
Use tests_list as withelist for ostestr in order to re-run failed test cases.
|
Use tests_list as withelist for ostestr in order to re-run failed test cases.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
ostestr --serial -w test_list
|
ostestr --serial -w test_list
|
||||||
|
|
||||||
Input: test_list and conf-file files.
|
Input: test_list and conf-file files.
|
||||||
|
@ -17,11 +17,12 @@ about tempest, the tempest.conf can be created automatically by the
|
|||||||
refstack-client and provide an example tempest.conf populated with values from
|
refstack-client and provide an example tempest.conf populated with values from
|
||||||
the target cloud.
|
the target cloud.
|
||||||
|
|
||||||
::
|
.. code-block:: bash
|
||||||
|
|
||||||
$ source openstackrc file
|
$ source openstackrc file
|
||||||
$ refstack-client config -h
|
$ refstack-client config -h
|
||||||
--os-cloud <name of the cloud> # Using specific cloud.yaml files
|
--os-cloud <name of the cloud> # Using specific cloud.yaml files
|
||||||
--use-test-accounts <Use accounts from accounts.yaml>
|
--use-test-accounts <Use accounts from accounts.yaml>
|
||||||
$ # we can also use discover-tempest-config to generate tempest.conf
|
$ # we can also use discover-tempest-config to generate tempest.conf
|
||||||
$ discover-tempest-config --create
|
$ discover-tempest-config --create
|
||||||
|
|
||||||
|
@ -2,11 +2,8 @@ pep8==1.4.5
|
|||||||
pyflakes>=0.7.2,<0.7.4
|
pyflakes>=0.7.2,<0.7.4
|
||||||
flake8==2.0
|
flake8==2.0
|
||||||
docutils>=0.11 # OSI-Approved Open Source, Public Domain
|
docutils>=0.11 # OSI-Approved Open Source, Public Domain
|
||||||
# required to build documentation
|
|
||||||
sphinx>=1.6.2 # BSD
|
|
||||||
stestr>=1.1.0 # Apache-2.0
|
stestr>=1.1.0 # Apache-2.0
|
||||||
testtools>=0.9.34
|
testtools>=0.9.34
|
||||||
mock
|
mock
|
||||||
coverage
|
coverage
|
||||||
httmock
|
httmock
|
||||||
openstackdocstheme>=1.11.0 # Apache-2.0
|
|
||||||
|
3
tox.ini
3
tox.ini
@ -33,7 +33,8 @@ commands =
|
|||||||
coverage report
|
coverage report
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands = python setup.py build_sphinx {posargs}
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
|
commands = sphinx-build -b html doc/source doc/build/html
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
# E125 continuation line does not distinguish itself from next logical line
|
# E125 continuation line does not distinguish itself from next logical line
|
||||||
|
Loading…
x
Reference in New Issue
Block a user