summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/include-documentation.rst
diff options
context:
space:
mode:
authorShubhamRathi <shubhamiiitbackup@gmail.com>2017-02-21 18:23:52 +0530
committerShubhamRathi <shubhamiiitbackup@gmail.com>2017-02-21 19:05:22 +0530
commit221d46ddaed5b9ae3841b6491f0be90a0812edb6 (patch)
tree4502adf6ad41d6df758c1f3c1ec6db76a568d239 /docs/how-to-use-docs/include-documentation.rst
parent5b6b3ed958264ecddc586624ba23bfc2d5c88a4c (diff)
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 <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/how-to-use-docs/include-documentation.rst')
-rw-r--r--docs/how-to-use-docs/include-documentation.rst22
1 files changed, 20 insertions, 2 deletions
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 <https://pypi.python.org/pypi/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 <file>
+
+
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 `<project>/docs/`. This is for testing only. Only commit the rst files and related content.