Updating README with correct tox instructions
Change-Id: I2f3bb54eb60199c1192912b0ac6e4ab33175a3ca
This commit is contained in:
parent
62098a14c4
commit
43124aeaba
10
README.rst
10
README.rst
|
@ -4,15 +4,15 @@ The OpenStack Contributor Guide
|
|||
|
||||
The Contributor Guide for the OpenStack project.
|
||||
|
||||
To build the manual, execute the following command::
|
||||
To build the guide, execute the following command::
|
||||
|
||||
$ tox
|
||||
$ tox -e docs
|
||||
|
||||
After running ``tox``, the documentation will be available for viewing
|
||||
in HTML format in the ``doc/build/`` directory.
|
||||
After running ``tox -e docs``, the guide will be available for viewing in HTML
|
||||
format in the ``doc/build/`` directory.
|
||||
|
||||
|
||||
* Free software: Apache license
|
||||
* Documentation: http://docs.openstack.org/developer/contributor-guide
|
||||
* Documentation: http://docs.openstack.org/contributors
|
||||
* Source: http://git.openstack.org/cgit/openstack/contributor-guide
|
||||
* Bugs: TODO
|
||||
|
|
Loading…
Reference in New Issue