From 446f5995ecb3ee00728c9a5d6d0ccb11dc93273b Mon Sep 17 00:00:00 2001
From: Pavlo Shchelokovskyy <pshchelokovskyy@mirantis.com>
Date: Tue, 8 Nov 2016 09:28:17 +0200
Subject: [PATCH] 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
---
 README.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.rst b/README.rst
index 4c2996e1..f7fb4fd9 100644
--- a/README.rst
+++ b/README.rst
@@ -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.