summaryrefslogtreecommitdiffstats
path: root/LICENSE
blob: 82681409e6cce69e56dbe6dc1b006ee1073bc6f1 (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13

Copyright 2017 Open Platform for NFV Project, Inc. and its contributors

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
l.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
========
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.