openstack
/
ironic-specs
Code Issues Proposed changes

Add hint on quick preview to README.rst 

add an example command to quickly generate an output to preview rst
rendering of a single spec.

Change-Id: I65afc79ebe18be6772d9c35fbd7cedf617d08313
This commit is contained in:
Pavlo Shchelokovskyy 2016-11-08 09:28:17 +02:00
parent b56100f21b
commit 446f5995ec
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -56,3 +56,11 @@ confidence in the Jenkins result), please execute the following command::
After running ``tox``, the documentation will be available for viewing in HTML
format in the ``doc/build/`` directory.
To quickly preview just the rst syntax rendering (without Sphinx features)
of a single spec file execute the following command::
$ tox -evenv rst2html.py <path-to-your-spec.rst> <path-to-output.html>
and open ``<path-to-output.html>`` in your browser.
Running full ``tox`` is still advised before submitting your patch.