openstack/openstack-manuals
Code Issues Proposed changes

Update RST build instructions in README

Browse Source 
Change-Id: I301edb870a16521a1c34f61c0bcd6ba4928306e5
This commit is contained in:
Akihiro Motoki 2015-10-17 23:15:47 +09:00
parent ee3eac12f5
commit d77dd9bb2e
1 changed files with 7 additions and 6 deletions

13
README.rst

@ -69,18 +69,19 @@ The root of the generated HTML documentation is::
RST guides RST guides
---------- ----------
Then, you can see that the openstack-manuals/doc/user-guides is the RST based guide, So we can't use mvn command. Then, you can see some guides written in the RST format, so we can't use mvn command.
You can use tox to prepare virtual environment and build it:: You can use tox to prepare virtual environment and build all RST based guides::
tox -e docs tox -e docs
The root of the generated *End User Guide* HTML documentation is:: You can also build a specific guide.
For example, to build *OpenStack End User Guide*, use the following command::
openstack-manuals/doc/user-guides/build/html/index.html tox -e build -- user-guide
The root of the generated *Admin User Guide* HTML documentation is:: You can find the root of the generated HTML documentation at::
openstack-manuals/doc/user-guides/build-admin/html/index.html openstack-manuals/doc/user-guide/build/html/index.html
Testing of changes and building of the manual Testing of changes and building of the manual
============================================= =============================================