From 28d11becf99d8ea879c118a0126846b5accb25ab Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Wed, 8 Mar 2017 17:25:08 +0100 Subject: Fixed warnings Updated structure for test docs Updates done according to agreement with test projects. Change-Id: I2f9b5783ef4e42fd26b357e0aad2e187bcf61777 Signed-off-by: Sofia Wallin --- docs/how-to-use-docs/include-documentation.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 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 4cf9f2757..1430b946d 100644 --- a/docs/how-to-use-docs/include-documentation.rst +++ b/docs/how-to-use-docs/include-documentation.rst @@ -1,14 +1,14 @@ .. _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 @@ -34,7 +34,7 @@ the documentation to the project repository. git review In OPNFVDocs Composite Documentation --------------------------------------- +------------------------------------ In toctree +++++++++++ @@ -70,7 +70,7 @@ it, example: As Hyperlink -+++++++++++++ +++++++++++++ It's pretty common to want to reference another location in the OPNFV documentation and it's pretty easy to do with @@ -126,8 +126,8 @@ 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 --------------------------------------- +'doc8' Validation +----------------- It is recommended that all rst content is validated by `doc8 `_ standards. To validate your rst files using doc8, install doc8. @@ -143,10 +143,10 @@ doc8 can now be used to check the rst files. Execute as, Testing: Build Documentation Locally ---------------------------------------- +------------------------------------ Composite OPNFVDOCS documentation -+++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++ To build whole documentation under opnfvdocs/, follow these steps: Install virtual environment. @@ -181,7 +181,7 @@ Update submodules, build documentation using tox & then open using any browser. .. 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. -- cgit 1.2.3-korg