1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
9 The index file must relatively reference your other rst files in that directory.
11 Here is an example index.rst :
28 Document source files have to be written in reStructuredText format (rst).
29 Each file would be build as an html page.
31 Here is an example source rst file :
50 See http://sphinx-doc.org/rest.html .
53 You can add html content that only appears in html output by using the
54 'only' directive with build type
55 ('html' and 'singlehtml') for an ONAP document. But, this is not encouraged.
60 This line will be shown only in html version.
68 The verify job name is **doc-{stream}-verify-rtd**
70 Proposed changes in doc or any other repository that has been added as a
71 git submodule will be verified by this job prior to a gerrit code review.
72 Please check the Jenkins log carefully for warnings.
73 You can improve your document even if the verify job succeeded.
78 The merge job name is **doc-{stream}-merge-rtd**.
80 When a committer merges a patch, Jenkins will automatically trigger building of
81 the new documentation. This might take about 15 minutes while readthedocs
82 builds the documentation. The newly built documentation shall show up
83 as appropriate placed in docs.onap.org/{branch}/path-to-file.