From 221d46ddaed5b9ae3841b6491f0be90a0812edb6 Mon Sep 17 00:00:00 2001 From: ShubhamRathi Date: Tue, 21 Feb 2017 18:23:52 +0530 Subject: Update OPNFVDocs documentation 1. Added note about eliminating conf.py etc from include-documentation. 2. Eliminated content about enabling toolchain since its irrelevant after migration to RTD 3. Added steps to validate using doc8 4. Populated index page. Change-Id: I80c8354fd4da4bca0b8f338c178f0773d834b6ee Signed-off-by: ShubhamRathi --- docs/how-to-use-docs/include-documentation.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'docs/how-to-use-docs/include-documentation.rst') diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst index 010ed4f7b..4cf9f2757 100644 --- a/docs/how-to-use-docs/include-documentation.rst +++ b/docs/how-to-use-docs/include-documentation.rst @@ -1,7 +1,7 @@ .. _include-documentation: -============================================= +============================= Including your Documentation -============================================= +============================= .. contents:: :depth: 3 @@ -126,6 +126,22 @@ the opnfvdocs team for review and integration. Be sure to add the project leader of the opnfvdocs project as a reviewer of the change you just pushed in gerrit. +'doc8' Validation +-------------------------------------- +It is recommended that all rst content is validated by `doc8 `_ standards. +To validate your rst files using doc8, install doc8. + +.. code-block:: bash + + sudo pip install doc8 + +doc8 can now be used to check the rst files. Execute as, + +.. code-block:: bash + + doc8 --ignore D000,D001 + + Testing: Build Documentation Locally --------------------------------------- @@ -208,3 +224,5 @@ Build the documentation from within your project folder: Your documentation shall be built as HTML inside the specified output folder directory. + +.. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `/docs/`. This is for testing only. Only commit the rst files and related content. -- cgit 1.2.3-korg