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 built 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.
63 .. index:: single: indices
68 Building an index for your Sphinx project is relatively simple. First, tell Sphinx that
69 you want it to build an index by adding something like this after your TOC tree:
80 Note that search was included here. It works out of the box with any Sphinx project, so you
81 don't need to do anything except include a reference to it in your :code:`index.rst` file.
83 Now, to generate a index entry in your RST, do one of the following:
87 Some content that requires an :index:`index`.
96 Some header containing myterm
97 =============================
99 In the second case, Sphinx will create a link in the index to the paragraph that follows
100 the index entry declaration.
102 When your project is built, Sphinx will generate an index page populated with the entries
103 you created in the source RST.
105 These are simple cases with simple options. For more information about indexing with Sphinx,
106 please see the `official Sphinx documentation <http://www.sphinx-doc.org/en/stable/markup/misc.html#directive-index>`_.
115 The verify job name is **doc-{stream}-verify-rtd**
117 Proposed changes in files in any repository with the path
121 will be verified by this job prior to a gerrit code review.
122 Please check the Jenkins log carefully for warnings.
123 You can improve your document even if the verify job succeeded.
128 The merge job name is **doc-{stream}-merge-rtd**.
130 When a committer merges a patch that includes files matching the path described above,
131 the doc project merge job will trigger an update at readthedocs.
132 This might take about 15 minutes while readthedocs
133 builds the documentation.