aboutsummaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/addendum.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/how-to-use-docs/addendum.rst')
-rw-r--r--docs/how-to-use-docs/addendum.rst80
1 files changed, 0 insertions, 80 deletions
diff --git a/docs/how-to-use-docs/addendum.rst b/docs/how-to-use-docs/addendum.rst
deleted file mode 100644
index 90ab1c7..0000000
--- a/docs/how-to-use-docs/addendum.rst
+++ /dev/null
@@ -1,80 +0,0 @@
-========
-Addendum
-========
-
-Index File
-==========
-
-The index file must relatively refence your other rst files in that directory.
-
-Here is an example index.rst :
-
-.. code-block:: bash
-
- *******************
- Documentation Title
- *******************
-
- .. toctree::
- :numbered:
- :maxdepth: 2
-
- documentation-example
-
-Source Files
-============
-
-Document source files have to be written in reStructuredText format (rst).
-Each file would be build as an html page.
-
-Here is an example source rst file :
-
-.. code-block:: bash
-
- =============
- Chapter Title
- =============
-
- Section Title
- =============
-
- Subsection Title
- ----------------
-
- Hello!
-
-Writing RST Markdown
-====================
-
-See http://sphinx-doc.org/rest.html .
-
-**Hint:**
-You can add dedicated contents by using 'only' directive with build type
-('html' and 'singlehtml') for OPNFV document. But, this is not encouraged to
-use since this may make different views.
-
-.. code-block:: bash
-
- .. only:: html
- This line will be shown only in html version.
-
-Verify Job
-----------
-
-The verify job name is **docs-verify-rtd-{branch}**.
-
-When you send document changes to gerrit, jenkins will create your documents
-in HTML formats (normal and single-page) to verify that new document can be
-built successfully. Please check the jenkins log and artifact carefully.
-You can improve your document even though if the build job succeeded.
-
-Merge Job
-----------
-
-The merge job name is **docs-merge-rtd-{branch}**.
-
-Once the patch is merged, jenkins will automatically trigger building of
-the new documentation. This might take about 15 minutes while readthedocs
-builds the documentatation. The newly built documentation shall show up
-as appropriate placed in docs.opnfv.org/{branch}/path-to-file.
-