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 ../$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"];
203 GIT is a powerful tool allowing many actions, but without respecting some rules
204 the GIT structure can be quickly ugly and unmaintaible.
206 Here are some conventions about GIT branches:
207 - ALWAYS create a local branch to edit or create any file. This local branch
208 will be considered as a topic in Gerrit and allow contributors to work at the
209 same time on the same project.
210 - 1 feature = 1 branch. In the case of documentation, a new chapter or page about
211 a new code feature can be considered as a 'doc feature'
212 - 1 bug = 1 branch. In the case of documentation, a correction on an existing
213 sentence can be considered as a 'doc bug'
214 - the master branch is considered as "unstable", containing new features that
215 will converge to a stable situation for the release date.
217 The day of the release, the repository owner will create a new branch to
218 fix the code and documentation. This will represent the 'stable' code of the
219 release. In this context:
220 - NEVER push a new feature on a stable branch
221 - Only bug correction are authorized on a stable branch using cherry pick method
223 .. image:: git_branches.png
225 Creating Restructured Text
226 ==========================
228 Templates and Examples
229 ----------------------
230 Templates are available that capture the kinds of information
231 useful for different types of projects and provide some examples of
232 restructured text. We organize templates in the following way to: help authors
233 understand relationships between documents; keep the user audience context in mind when writing;
234 and tailor sections for different kinds of projects.
236 **Sections** Represent a certain type of content. A section is **provided** in a repository, to
237 to describe something about the characteristics, use, capability, etc. of things in that repository.
238 A section may also be **referenced** from other sections and in other repositories.
239 The notes in the beginning of each section template provide
240 additional detail about what is typically covered and where there may be references to the section.
242 **Collections** Are a set of sections that are typically provided for a particular type
243 of project, repository, guide, reference manual, etc.
245 You can: browse the template *collections* and *sections* below; show source to look at the Restructured
246 Text and Sphinx directives used; copy the source either from a browser window
247 or by downloading the file in raw form from
248 the `gerrit doc repository <https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree;f=docs/templates;/>`_ and
249 then add them to your repository docs folder and index.rst.
259 ../../../templates/sections/*
269 ../../../templates/collections/*
273 In addition to these simple templates and examples
274 there are many open source projects (e.g. Open Daylight, Open Stack)
275 that are using Sphinx and Readthedocs where you may find examples to start with.
276 Working with project teams we will continue to enhance templates here and
277 capture frequently asked questions on the developer wiki question
278 topic `documentation <https://wiki.onap.org/questions/topics/16384055/documentation>`_.
280 Each project should: decide what is relevant content; determine the
281 best way to create/maintain it in a CI/CD process; and work with the
282 documentation team to reference content from the master index and guides.
283 Consider options including filling in a template,
284 identifying existing content that can be used as is or
285 easily converted, and use of Sphinx directives/extensions to automatically
286 generate restructured text from other source you already have.
290 It's pretty common to want to reference another location in the
291 ONAP documentation and it's pretty easy to do with
292 reStructuredText. This is a quick primer, more information is in the
293 `Sphinx section on Cross-referencing arbitrary locations
294 <http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_.
296 Within a single document, you can reference another section simply by::
298 This is a reference to `The title of a section`_
300 Assuming that somewhere else in the same file there a is a section
301 title something like::
303 The title of a section
304 ^^^^^^^^^^^^^^^^^^^^^^
306 It's typically better to use ``:ref:`` syntax and labels to provide
307 links as they work across files and are resilient to sections being
308 renamed. First, you need to create a label something like::
312 The title of a section
313 ^^^^^^^^^^^^^^^^^^^^^^
315 .. note:: The underscore (_) before the label is required.
317 Then you can reference the section anywhere by simply doing::
319 This is a reference to :ref:`a-label`
323 This is a reference to :ref:`a section I really liked <a-label>`
325 .. note:: When using ``:ref:``-style links, you don't need a trailing
328 Because the labels have to be unique, it usually makes sense to prefix
329 the labels with the project name to help share the label space, e.g.,
330 ``sfc-user-guide`` instead of just ``user-guide``.
337 It is recommended that all rst content is validated by `doc8 <https://pypi.python.org/pypi/doc8>`_ standards.
338 To validate your rst files using doc8, install doc8.
342 sudo pip install doc8
344 doc8 can now be used to check the rst files. Execute as,
348 doc8 --ignore D000,D001 <file>
354 To test how the documentation renders in HTML, follow these steps:
356 Install virtual environment.
360 sudo pip install virtualenv
361 cd /local/repo/path/to/project
363 Download the doc repository.
367 git clone http://gerrit.onap.org/r/doc
369 Change directory to doc & install requirements.
374 sudo pip install -r etc/requirements.txt
376 Move the conf.py file to your project folder where RST files have been kept:
380 mv doc/docs/conf.py <path-to-your-folder>/
382 Move the static files to your project folder:
386 mv docs/_static/ <path-to-your-folder>/
388 Build the documentation from within your project folder:
392 sphinx-build -b html <path-to-your-folder> <path-to-output-folder>
394 Your documentation shall be built as HTML inside the
395 specified output folder directory.
397 .. 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.
399 .. _building-all-documentation:
403 To build the whole documentation under doc/, follow these steps:
405 Install virtual environment.
409 sudo pip install virtualenv
410 cd /local/repo/path/to/project
412 Download the DOC repository.
416 git clone http://gerrit.onap.org/r/doc
418 Update submodules, build documentation using tox & then open using any browser.
424 firefox docs/_build/html/index.html
426 .. note:: Make sure to run `tox -elocal` and not just `tox`.