blob: f97541730f94cdb47a7c2dc7e5b823651b8165da (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Addendum
========
Index File
----------
The index file must relatively reference 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 html content that only appears in html output by using the
'only' directive with build type
('html' and 'singlehtml') for an ONAP document. But, this is not encouraged.
.. code-block:: bash
.. only:: html
This line will be shown only in html version.
Jenkins Jobs
------------
Verify Job
++++++++++
The verify job name is **doc-{stream}-verify-rtd**
Proposed changes in doc or any other repository that has been added as a
git submodule will be verified by this job prior to a gerrit code review.
Please check the Jenkins log carefully for warnings.
You can improve your document even if the verify job succeeded.
Merge Job
+++++++++
The merge job name is **doc-{stream}-merge-rtd**.
When a committer merges a patch, Jenkins will automatically trigger building of
the new documentation. This might take about 15 minutes while readthedocs
builds the documentation. The newly built documentation shall show up
as appropriate placed in docs.onap.org/{branch}/path-to-file.
|
