1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
7 Some initial set up is required to connect a project with
8 the master document structure and enable automated publishing of
9 changes as summarized in the following diagram and description below
17 RD [label = "Read The Docs", color =lightgreen ];
18 DA [label = "Doc Project\nAuthor/Committer", color=lightblue];
19 DR [label = "Doc Gerrit Repo" , color=pink];
20 PR [label = "Other Project\nGerrit Repo", color=pink ];
21 PA [label = "Other Project\nAuthor/Committer", color=lightblue];
23 === One time setup doc project only ===
24 RD -> DA [label = "Acquire Account" ];
25 DA -> DR [label = "Create initial\n doc repository content"];
26 DA <<-- DR [label = "Merge" ];
27 RD <-- DA [label = "Connect gerrit.onap.org" ];
28 === For each project repository containing document source ===
29 PA -> DR [label = "Add project repo as\ngit submodule" ];
30 DR -> DA [label = "Review & Plan to\nIntegrate Content with\nTocTree Structure" ];
31 DR <-- DA [label = "Vote +2/Merge" ];
32 PA <-- DR [label = "Merge Notification" ];
33 PA -> PR [label = "Create in project repo\ntop level directory and index.rst" ];
34 PR -> DA [label = "Add as Reviewer" ];
35 PR <-- DA [label = "Approve and Integrate" ];
36 PA <-- PR [label = "Merge" ];
43 These steps are performed only once for the doc project and include:
45 (1) creating in the doc repository an initial:
46 - sphinx master document index
47 - a directory structure aligned with the document structure
48 - tests performed in jenkins verify jobs
49 - sphinx configuration
51 (2) establishing an account at readthedocs connected with the doc
52 doc project repo in gerrit.onap.org.
55 Setup project repositories(s)
56 -----------------------------
57 These steps are performed for each project repository that provides documentation.
59 First let's set two variables that will be used in the subsequent steps.
60 Set reponame to the project repository you are setting up just as it appears in the
61 **Project Name** column of the Gerrit projects page.
62 Set lfid to your Linux Foundation identity that you use to login to gerrit or for git
63 clone requests over ssh.
70 The next step is to add a directory in the doc project where your project will be included as a
71 submodule and at least one reference from the doc project to the documentation index in your repository.
72 The following sequence will do this over ssh.
76 If your access network restricts ssh, you will need to use equivalent git commands and
77 HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_.
81 git clone ssh://$lfid@gerrit.onap.org:29418/doc
83 mkdir -p `dirname docs/submodules/$reponame`
84 git submodule add https://gerrit.onap.org/r/$reponame docs/submodules/$reponame.git
85 git submodule init docs/submodules/$reponame.git
86 git submodule update docs/submodules/$reponame.git
88 echo " $reponame <../submodules/$reponame.git/docs/index>" >> docs/release/repolist.rst
95 Wait for the above change to be merged before any merge to the
96 project repository that you have just added as a submodule.
97 If the project repository added as submodule changes before the doc project merge, git may not
98 automatically update the submodule reference on changes and/or the verify job will
99 fail in the step below.
102 The last step is to create a docs directory in your repository with an index.rst file.
103 The following sequence will complete the minimum required over ssh. As you have time
104 to convert or add new content you can update the index and add files under the docs folder.
107 If you have additional content, you can include it by editing the
108 index.rst file and/or adding other files before the git commit.
109 See `Templates and Examples`_ below and :ref:`converting-to-rst` for more information.
114 git clone ssh://$lfid@gerrit.onap.org:29418/$reponame
117 echo ".. This work is licensed under a Creative Commons Attribution 4.0 International License.
119 TODO Add files to toctree and delete this header
120 ------------------------------------------------
131 The diagram below illustrates what is accomplished in the setup steps
132 above from the perspective of a file structure created for a local test,
133 a jenkins verify job, and/or published release documentation including:
135 - ONAP gerrit project repositories,
136 - doc project repository master document index.rst, templates, configuration, and other documents
137 - submodules directory where other project repositories and directories/files are referenced
138 - file structure: directories (ellipses), files(boxes)
139 - references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)
145 digraph docstructure {
147 node [fontname = "helvetica"];
148 // Align gerrit repos and docs directories
149 {rank=same doc aaf aai reponame repoelipse vnfsdk vvp}
150 {rank=same confpy release templates masterindex submodules otherdocdocumentelipse}
151 {rank=same releasedocumentindex releaserepolist}
153 //Illustrate Gerrit Repos and provide URL/Link for complete repo list
154 gerrit [label="gerrit.onap.org/r", href="https://gerrit.onap.org/r/#/admin/projects/" ];
155 doc [href="https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree"];
160 gerrit -> repoelipse;
161 repoelipse [label=". . . ."];
165 //Show example of local reponame instance of component info
166 reponame -> reponamedocsdir;
167 reponamesm -> reponamedocsdir;
168 reponamedocsdir [label="docs"];
169 reponamedocsdir -> repnamedocsdirindex;
170 repnamedocsdirindex [label="index.rst", shape=box];
172 //Show detail structure of a portion of doc/docs
175 confpy [label="conf.py",shape=box];
177 masterindex [label="Master\nindex.rst", shape=box];
180 docs -> otherdocdocumentelipse;
181 otherdocdocumentelipse [label="...other\ndocuments"];
184 masterindex -> releasedocumentindex [style=dashed, label="sphinx\ntoctree\nreference"];
186 //Show submodule linkage to docs directory
187 submodules -> reponamesm [style=dotted,label="git\nsubmodule\nreference"];
188 reponamesm [label="reponame.git"];
190 //Example Release document index that references component info provided in other project repo
191 release -> releasedocumentindex;
192 releasedocumentindex [label="index.rst", shape=box];
193 releasedocumentindex -> releaserepolist [style=dashed, label="sphinx\ntoctree\nreference"];
194 releaserepolist [label="repolist.rst", shape=box];
195 release -> releaserepolist;
196 releaserepolist -> repnamedocsdirindex [style=dashed, label="sphinx\ntoctree\nreference"];
200 Creating Restructured Text
201 ==========================
203 Templates and Examples
204 ----------------------
205 Some templates are available that capture the kinds of information
206 useful for different types of projects and provide simple examples of
208 You can: browse the templates below; show source to look at the Restructured
209 Text and Sphinx directives used; and then copy the source either from a browser window
210 or by downloading the file in raw form from
211 the `gerrit doc repository <https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree;f=docs/templates;/>`_.
217 ../../../templates/**/index
219 In addition to these simple templates and examples
220 there are many open source projects (e.g. Open Daylight, Open Stack)
221 that are using Sphinx and Readthedocs where you may find examples to start with.
222 Working with project teams we will continue to enhance templates here and
223 capture frequently asked questions on the developer wiki question
224 topic `documentation <https://wiki.onap.org/questions/topics/16384055/documentation>`_.
226 Each project should: decide what is relevant content; determine the
227 best way to create/maintain it in a CI/CD process; and work with the
228 documentation team to reference content from the master index and guides.
229 Consider options including filling in a template,
230 identifying existing content that can be used as is or
231 easily converted, and use of Sphinx directives/extensions to automatically
232 generate restructured text from other source you already have.
236 It's pretty common to want to reference another location in the
237 ONAP documentation and it's pretty easy to do with
238 reStructuredText. This is a quick primer, more information is in the
239 `Sphinx section on Cross-referencing arbitrary locations
240 <http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_.
242 Within a single document, you can reference another section simply by::
244 This is a reference to `The title of a section`_
246 Assuming that somewhere else in the same file there a is a section
247 title something like::
249 The title of a section
250 ^^^^^^^^^^^^^^^^^^^^^^
252 It's typically better to use ``:ref:`` syntax and labels to provide
253 links as they work across files and are resilient to sections being
254 renamed. First, you need to create a label something like::
258 The title of a section
259 ^^^^^^^^^^^^^^^^^^^^^^
261 .. note:: The underscore (_) before the label is required.
263 Then you can reference the section anywhere by simply doing::
265 This is a reference to :ref:`a-label`
269 This is a reference to :ref:`a section I really liked <a-label>`
271 .. note:: When using ``:ref:``-style links, you don't need a trailing
274 Because the labels have to be unique, it usually makes sense to prefix
275 the labels with the project name to help share the label space, e.g.,
276 ``sfc-user-guide`` instead of just ``user-guide``.
283 It is recommended that all rst content is validated by `doc8 <https://pypi.python.org/pypi/doc8>`_ standards.
284 To validate your rst files using doc8, install doc8.
288 sudo pip install doc8
290 doc8 can now be used to check the rst files. Execute as,
294 doc8 --ignore D000,D001 <file>
300 To test how the documentation renders in HTML, follow these steps:
302 Install virtual environment.
306 sudo pip install virtualenv
307 cd /local/repo/path/to/project
309 Download the doc repository.
313 git clone http://gerrit.onap.org/r/doc
315 Change directory to doc & install requirements.
320 sudo pip install -r etc/requirements.txt
322 Move the conf.py file to your project folder where RST files have been kept:
326 mv doc/docs/conf.py <path-to-your-folder>/
328 Move the static files to your project folder:
332 mv docs/_static/ <path-to-your-folder>/
334 Build the documentation from within your project folder:
338 sphinx-build -b html <path-to-your-folder> <path-to-output-folder>
340 Your documentation shall be built as HTML inside the
341 specified output folder directory.
343 .. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`. This is for testing only. Only commit the rst files and related content.
345 .. _building-all-documentation:
349 To build the whole documentation under doc/, follow these steps:
351 Install virtual environment.
355 sudo pip install virtualenv
356 cd /local/repo/path/to/project
358 Download the DOC repository.
362 git clone http://gerrit.onap.org/r/doc
364 Change directory to docs & install requirements.
369 sudo pip install -r etc/requirements.txt
371 Update submodules, build documentation using tox & then open using any browser.
376 git submodule update --init
378 firefox docs/_build/html/index.html
380 .. note:: Make sure to run `tox -edocs` and not just `tox`.