.. _include-documentation:
-=============================
+============================
Including your Documentation
-=============================
+============================
.. contents::
:depth: 3
:local:
In your project repository
-----------------------------
+--------------------------
Add your documentation to your repository in the folder structure and
according to the templates listed above. The documentation templates you
git review
In OPNFVDocs Composite Documentation
---------------------------------------
+------------------------------------
In toctree
+++++++++++
<submodules/path-to-your-file>
As Hyperlink
-+++++++++++++
+++++++++++++
It's pretty common to want to reference another location in the
OPNFV documentation and it's pretty easy to do with
Be sure to add the project leader of the opnfvdocs project
as a reviewer of the change you just pushed in gerrit.
-'doc8' Validation
---------------------------------------
+'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.
Testing: Build Documentation Locally
----------------------------------------
+------------------------------------
Composite OPNFVDOCS documentation
-+++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++
To build whole documentation under opnfvdocs/, follow these steps:
Install virtual environment.
.. note:: Make sure to run `tox -edocs` and not just `tox`.
Individual project documentation
-+++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++
To test how the documentation renders in HTML, follow these steps:
Install virtual environment.