From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Tue, 6 Feb 2018 22:34:03 +0000 (-0500)
Subject: Add a step to test the docs generation
X-Git-Tag: v0.2.1~11
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F04%2F8704%2F2;p=releng%2Fdocs-conf.git

Add a step to test the docs generation

Includes details on how to test and review the docs locally.

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

diff --git a/docs/install.rst b/docs/install.rst
index 7e3bc0b..295e92f 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -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.