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:
Luz Cazares 2017-12-18 15:05:28 -08:00
parent 2619ebac4d
commit d1bfd90593
7 changed files with 13 additions and 11 deletions

View File

@ -1,6 +1,6 @@
========================
===============
RefStack Client
========================
===============
RefStack-client team and repository tags
########################################

2
doc/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0

View File

@ -1,6 +1,6 @@
=======================
==============================
Refstack-Client Specifications
=======================
==============================
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

View File

@ -132,6 +132,7 @@ installation.
Use tests_list as withelist for ostestr in order to re-run failed test cases.
.. code-block:: bash
ostestr --serial -w test_list
Input: test_list and conf-file files.

View File

@ -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
the target cloud.
::
.. code-block:: bash
$ source openstackrc file
$ refstack-client config -h
--os-cloud <name of the cloud> # Using specific cloud.yaml files
--use-test-accounts <Use accounts from accounts.yaml>
--os-cloud <name of the cloud> # Using specific cloud.yaml files
--use-test-accounts <Use accounts from accounts.yaml>
$ # we can also use discover-tempest-config to generate tempest.conf
$ discover-tempest-config --create

View File

@ -2,11 +2,8 @@ pep8==1.4.5
pyflakes>=0.7.2,<0.7.4
flake8==2.0
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
testtools>=0.9.34
mock
coverage
httmock
openstackdocstheme>=1.11.0 # Apache-2.0

View File

@ -33,7 +33,8 @@ commands =
coverage report
[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]
# E125 continuation line does not distinguish itself from next logical line