Add a step to test the docs generation 04/8704/2
authorThanh Ha <thanh.ha@linuxfoundation.org>
Tue, 6 Feb 2018 22:34:03 +0000 (17:34 -0500)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Tue, 6 Feb 2018 22:36:50 +0000 (17:36 -0500)
Includes details on how to test and review the docs locally.

Change-Id: I0eb3761d0738ee511439b42bb107737fbd517d1b
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
docs/install.rst

index 7e3bc0b..295e92f 100644 (file)
@@ -70,3 +70,12 @@ Follow these steps to install lfdocs-conf:
       The logo should be a small 64x64 png image.
 
 #. (Optional) Copy a favicon to docs/_static/favicon.ico
+#. To test run::
+
+     tox -e docs
+     google-chrome-stable docs/_build/html/index.html
+
+   .. note::
+
+      Replace the last command with your favourite web browser to view a
+      the generated docs.