From d4d7ae6e3b6e6c3291dd85b43f4c3ee56badb03a Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Tue, 6 Feb 2018 17:34:03 -0500 Subject: [PATCH] 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 --- docs/install.rst | 9 +++++++++ 1 file changed, 9 insertions(+) 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. -- 2.16.6