womax/nova
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update HACKING.rst for running tests and building docs

Browse Source 
There are three updates here:

1. Point to the correct path of development.environment.rst.
2. Update the path to test_wsgi.py after the test restructure
   that happened in Kilo.
3. Just tell people to use `tox -e docs` for building docs.

Change-Id: I03295a6d9c90e9a2962999726d254bc4971c4909
This commit is contained in:
Matt Riedemann
2015-07-14 11:56:45 -07:00
parent 42d91ebee0
commit f72b7e35c8
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
HACKING.rst
+3 -3
View File
@@ -76,13 +76,13 @@ testr arguments that are needed to tox. For example, you can run:
--analyze-isolation to its argument list. --analyze-isolation to its argument list.
Python packages may also have dependencies that are outside of tox's ability Python packages may also have dependencies that are outside of tox's ability
to install. Please refer to doc/source/devref/development.environment.rst for to install. Please refer to ``doc/source/development.environment.rst`` for
a list of those packages on Ubuntu, Fedora and Mac OS X. a list of those packages on Ubuntu, Fedora and Mac OS X.
To run a single or restricted set of tests, pass a regex that matches To run a single or restricted set of tests, pass a regex that matches
the class name containing the tests as an extra ``tox`` argument; the class name containing the tests as an extra ``tox`` argument;
e.g. ``tox -- TestWSGIServer`` (note the double-hypen) will test all e.g. ``tox -- TestWSGIServer`` (note the double-hypen) will test all
WSGI server tests from ``nova/tests/test_wsgi.py``; ``-- WSGI server tests from ``nova/tests/unit/test_wsgi.py``; ``--
TestWSGIServer.test_uri_length_limit`` would run just that test, and TestWSGIServer.test_uri_length_limit`` would run just that test, and
``-- TestWSGIServer|TestWSGIServerWithSSL`` would run tests from both ``-- TestWSGIServer|TestWSGIServerWithSSL`` would run tests from both
classes. classes.
@@ -98,7 +98,7 @@ http://wiki.openstack.org/testr
Building Docs Building Docs
------------- -------------
Normal Sphinx docs can be built via the setuptools ``build_sphinx`` command. To Normal Sphinx docs can be built via the setuptools ``build_sphinx`` command. To
do this via ``tox``, simply run ``tox -evenv -- python setup.py build_sphinx``, do this via ``tox``, simply run ``tox -e docs``,
which will cause a virtualenv with all of the needed dependencies to be which will cause a virtualenv with all of the needed dependencies to be
created and then inside of the virtualenv, the docs will be created and created and then inside of the virtualenv, the docs will be created and
put into doc/build/html. put into doc/build/html.