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:
47 - sphinx master document index
49 - a directory structure aligned with the document structure
51 - tests performed in jenkins verify jobs
53 - sphinx configuration
55 (2) establishing an account at readthedocs connected with the doc
56 doc project repo in gerrit.onap.org.
59 Setup project repositories(s)
60 -----------------------------
61 These steps are performed for each project repository that provides documentation.
63 First let's set two variables that will be used in the subsequent steps.
64 Set reponame to the project repository you are setting up just as it appears in the
65 **Project Name** column of the Gerrit projects page.
66 Set lfid to your Linux Foundation identity that you use to login to gerrit or for git
67 clone requests over ssh.
74 The next step is to add a directory in the doc project where your project will be included as a
75 submodule and at least one reference from the doc project to the documentation index in your repository.
76 The following sequence will do this over ssh.
80 If your access network restricts ssh, you will need to use equivalent git commands and
81 HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_.
85 git clone ssh://$lfid@gerrit.onap.org:29418/doc
87 mkdir -p `dirname docs/submodules/$reponame`
88 git submodule add ../$reponame docs/submodules/$reponame.git
89 git submodule init docs/submodules/$reponame.git
90 git submodule update docs/submodules/$reponame.git
92 echo " $reponame <../submodules/$reponame.git/docs/index>" >> docs/release/repolist.rst
99 Wait for the above change to be merged before any merge to the
100 project repository that you have just added as a submodule.
101 If the project repository added as submodule changes before the doc project merge, git may not
102 automatically update the submodule reference on changes and/or the verify job will
103 fail in the step below.
106 The last step is to create a docs directory in your repository with an index.rst file.
107 The following sequence will complete the minimum required over ssh. As you have time
108 to convert or add new content you can update the index and add files under the docs folder.
111 If you have additional content, you can include it by editing the
112 index.rst file and/or adding other files before the git commit.
113 See `Templates and Examples`_ below and :ref:`converting-to-rst` for more information.
118 git clone ssh://$lfid@gerrit.onap.org:29418/$reponame
121 echo ".. This work is licensed under a Creative Commons Attribution 4.0 International License.
123 TODO Add files to toctree and delete this header
124 ------------------------------------------------
135 The diagram below illustrates what is accomplished in the setup steps
136 above from the perspective of a file structure created for a local test,
137 a jenkins verify job, and/or published release documentation including:
139 - ONAP gerrit project repositories,
140 - doc project repository master document index.rst, templates, configuration, and other documents
141 - submodules directory where other project repositories and directories/files are referenced
142 - file structure: directories (ellipses), files(boxes)
143 - references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)
149 digraph docstructure {
151 node [fontname = "helvetica"];
152 // Align gerrit repos and docs directories
153 {rank=same doc aaf aai reponame repoelipse vnfsdk vvp}
154 {rank=same confpy release templates masterindex submodules otherdocdocumentelipse}
155 {rank=same releasedocumentindex releaserepolist}
157 //Illustrate Gerrit Repos and provide URL/Link for complete repo list
158 gerrit [label="gerrit.onap.org/r", href="https://gerrit.onap.org/r/#/admin/projects/" ];
159 doc [href="https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree"];
164 gerrit -> repoelipse;
165 repoelipse [label=". . . ."];
169 //Show example of local reponame instance of component info
170 reponame -> reponamedocsdir;
171 reponamesm -> reponamedocsdir;
172 reponamedocsdir [label="docs"];
173 reponamedocsdir -> repnamedocsdirindex;
174 repnamedocsdirindex [label="index.rst", shape=box];
176 //Show detail structure of a portion of doc/docs
179 confpy [label="conf.py",shape=box];
181 masterindex [label="Master\nindex.rst", shape=box];
184 docs -> otherdocdocumentelipse;
185 otherdocdocumentelipse [label="...other\ndocuments"];
188 masterindex -> releasedocumentindex [style=dashed, label="sphinx\ntoctree\nreference"];
190 //Show submodule linkage to docs directory
191 submodules -> reponamesm [style=dotted,label="git\nsubmodule\nreference"];
192 reponamesm [label="reponame.git"];
194 //Example Release document index that references component info provided in other project repo
195 release -> releasedocumentindex;
196 releasedocumentindex [label="index.rst", shape=box];
197 releasedocumentindex -> releaserepolist [style=dashed, label="sphinx\ntoctree\nreference"];
198 releaserepolist [label="repolist.rst", shape=box];
199 release -> releaserepolist;
200 releaserepolist -> repnamedocsdirindex [style=dashed, label="sphinx\ntoctree\nreference"];
207 GIT is a powerful tool allowing many actions, but without respecting some rules
208 the GIT structure can be quickly ugly and unmaintaible.
210 Here are some conventions about GIT branches:
211 - ALWAYS create a local branch to edit or create any file. This local branch
212 will be considered as a topic in Gerrit and allow contributors to work at the
213 same time on the same project.
214 - 1 feature = 1 branch. In the case of documentation, a new chapter or page about
215 a new code feature can be considered as a 'doc feature'
216 - 1 bug = 1 branch. In the case of documentation, a correction on an existing
217 sentence can be considered as a 'doc bug'
218 - the master branch is considered as "unstable", containing new features that
219 will converge to a stable situation for the release date.
221 The day of the release, the repository owner will create a new branch to
222 fix the code and documentation. This will represent the 'stable' code of the
223 release. In this context:
225 - NEVER push a new feature on a stable branch
227 - Only bug correction are authorized on a stable branch using cherry pick method
229 .. image:: git_branches.png
231 Creating Restructured Text
232 ==========================
234 Templates and Examples
235 ----------------------
236 Templates are available that capture the kinds of information
237 useful for different types of projects and provide some examples of
238 restructured text. We organize templates in the following way to: help authors
239 understand relationships between documents; keep the user audience context in mind when writing;
240 and tailor sections for different kinds of projects.
242 **Sections** Represent a certain type of content. A section is **provided** in a repository, to
243 to describe something about the characteristics, use, capability, etc. of things in that repository.
244 A section may also be **referenced** from other sections and in other repositories.
245 The notes in the beginning of each section template provide
246 additional detail about what is typically covered and where there may be references to the section.
248 **Collections** Are a set of sections that are typically provided for a particular type
249 of project, repository, guide, reference manual, etc.
251 You can: browse the template *collections* and *sections* below; show source to look at the Restructured
252 Text and Sphinx directives used; copy the source either from a browser window
253 or by downloading the file in raw form from
254 the `gerrit doc repository <https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree;f=docs/templates;/>`_ and
255 then add them to your repository docs folder and index.rst.
265 ../../../templates/sections/*
275 ../../../templates/collections/*
279 In addition to these simple templates and examples
280 there are many open source projects (e.g. Open Daylight, Open Stack)
281 that are using Sphinx and Readthedocs where you may find examples to start with.
282 Working with project teams we will continue to enhance templates here and
283 capture frequently asked questions on the developer wiki question
284 topic `documentation <https://wiki.onap.org/questions/topics/16384055/documentation>`_.
286 Each project should: decide what is relevant content; determine the
287 best way to create/maintain it in a CI/CD process; and work with the
288 documentation team to reference content from the master index and guides.
289 Consider options including filling in a template,
290 identifying existing content that can be used as is or
291 easily converted, and use of Sphinx directives/extensions to automatically
292 generate restructured text from other source you already have.
296 It's pretty common to want to reference another location in the
297 ONAP documentation and it's pretty easy to do with
298 reStructuredText. This is a quick primer, more information is in the
299 `Sphinx section on Cross-referencing arbitrary locations
300 <http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_.
302 Within a single document, you can reference another section simply by::
304 This is a reference to `The title of a section`_
306 Assuming that somewhere else in the same file there a is a section
307 title something like::
309 The title of a section
310 ^^^^^^^^^^^^^^^^^^^^^^
312 It's typically better to use ``:ref:`` syntax and labels to provide
313 links as they work across files and are resilient to sections being
314 renamed. First, you need to create a label something like::
318 The title of a section
319 ^^^^^^^^^^^^^^^^^^^^^^
321 .. note:: The underscore (_) before the label is required.
323 Then you can reference the section anywhere by simply doing::
325 This is a reference to :ref:`a-label`
329 This is a reference to :ref:`a section I really liked <a-label>`
331 .. note:: When using ``:ref:``-style links, you don't need a trailing
334 Because the labels have to be unique, it usually makes sense to prefix
335 the labels with the project name to help share the label space, e.g.,
336 ``sfc-user-guide`` instead of just ``user-guide``.
343 It is recommended that all rst content is validated by `doc8 <https://pypi.python.org/pypi/doc8>`_ standards.
344 To validate your rst files using doc8, install doc8.
348 sudo pip install doc8
350 doc8 can now be used to check the rst files. Execute as,
354 doc8 --ignore D000,D001 <file>
360 To test how the documentation renders in HTML, follow these steps:
362 Install virtual environment.
366 sudo pip install virtualenv
367 cd /local/repo/path/to/project
369 Download the doc repository.
373 git clone http://gerrit.onap.org/r/doc
375 Change directory to doc & install requirements.
380 sudo pip install -r etc/requirements.txt
382 Move the conf.py file to your project folder where RST files have been kept:
386 mv doc/docs/conf.py <path-to-your-folder>/
388 Move the static files to your project folder:
392 mv docs/_static/ <path-to-your-folder>/
394 Build the documentation from within your project folder:
398 sphinx-build -b html <path-to-your-folder> <path-to-output-folder>
400 Your documentation shall be built as HTML inside the
401 specified output folder directory.
403 .. 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.
405 .. _building-all-documentation:
409 To build the whole documentation under doc/, follow these steps:
411 Install virtual environment.
415 sudo pip install virtualenv
416 cd /local/repo/path/to/project
418 Download the DOC repository.
422 git clone http://gerrit.onap.org/r/doc
424 Update submodules, build documentation using tox & then open using any browser.
430 firefox docs/_build/html/index.html
432 .. note:: Make sure to run `tox -elocal` and not just `tox`.