8 The index file must relatively refence your other rst files in that directory.
10 Here is an example index.rst :
27 Document source files have to be written in reStructuredText format (rst).
28 Each file would be build as an html page.
30 Here is an example source rst file :
49 See http://sphinx-doc.org/rest.html .
52 You can add dedicated contents by using 'only' directive with build type
53 ('html' and 'singlehtml') for OPNFV document. But, this is not encouraged to
54 use since this may make different views.
59 This line will be shown only in html version.
64 The verify job name is **docs-verify-rtd-{branch}**.
66 When you send document changes to gerrit, jenkins will create your documents
67 in HTML formats (normal and single-page) to verify that new document can be
68 built successfully. Please check the jenkins log and artifact carefully.
69 You can improve your document even though if the build job succeeded.
74 The merge job name is **docs-merge-rtd-{branch}**.
76 Once the patch is merged, jenkins will automatically trigger building of
77 the new documentation. This might take about 15 minutes while readthedocs
78 builds the documentatation. The newly built documentation shall show up
79 as appropriate placed in docs.opnfv.org/{branch}/path-to-file.