summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-02-23 23:12:24 -0800
committerTrevor Cooper <trevor.cooper@intel.com>2016-02-24 15:02:42 -0800
commitc8f8facec439fbc4fced0854845070caf9db38a5 (patch)
tree63e82faa04f6ded59b869838240b803718418445 /docs/how-to-use-docs
parentb2231a970fb73f4f5df72b59ed9d58a039644ac3 (diff)
Removed index files from all doc directories, rearranged headings, fixed broken links and doc formatting issues, created platform overview file, edited content.brahmaputra.1.0
Change-Id: I08113c732dc6bc5967fe263aecfa8734e4c98ee5 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs/how-to-use-docs')
-rw-r--r--docs/how-to-use-docs/documentation-example.rst12
-rw-r--r--docs/how-to-use-docs/index.rst4
2 files changed, 4 insertions, 12 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
index 1d1ca6d..54819dc 100644
--- a/docs/how-to-use-docs/documentation-example.rst
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -4,9 +4,12 @@
:width: 200
:alt: OPNFV
:align: left
+
.. these two pipes are to seperate the logo from the first title
+
|
|
+
How to create documentation for your OPNFV project
==================================================
@@ -44,10 +47,6 @@ This index file must refence your other rst files.
* :ref:`search`
- Revision: _sha1_
-
- Build date: |today|
-
The Sphinx Build
================
@@ -55,6 +54,7 @@ The Sphinx Build
When you push documentation changes to gerrit a jenkins job will create html documentation.
* Verify Jobs
+
For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
* Merge jobs
@@ -80,7 +80,3 @@ links are easy to add: Here is a link to sphinx, the tool that we are using to g
Leave these at the bottom of each of your documents they are used internally
-
-Revision: _sha1_
-
-Build date: |today|
diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst
index 36710b3..2fea43e 100644
--- a/docs/how-to-use-docs/index.rst
+++ b/docs/how-to-use-docs/index.rst
@@ -24,7 +24,3 @@ Indices and tables
==================
* :ref:`search`
-
-Revision: _sha1_
-
-Build date: |today|