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"];
200 Creating Restructured Text
201 ==========================
203 Templates and Examples
204 ----------------------
205 Templates are available that capture the kinds of information
206 useful for different types of projects and provide some examples of
207 restructured text. We organize templates in the following way to: help authors
208 understand relationships between documents; keep the user audience context in mind when writing;
209 and tailor sections for different kinds of projects.
211 **Sections** Represent a certain type of content. A section is **provided** in a repository, to
212 to describe something about the characteristics, use, capability, etc. of things in that repository.
213 A section may also be **referenced** from other sections and in other repositories.
214 The notes in the beginning of each section template provide
215 additional detail about what is typically covered and where there may be references to the section.
217 **Collections** Are a set of sections that are typically provided for a particular type
218 of project, repository, guide, reference manual, etc.
220 You can: browse the template *collections* and *sections* below; show source to look at the Restructured
221 Text and Sphinx directives used; copy the source either from a browser window
222 or by downloading the file in raw form from
223 the `gerrit doc repository <https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree;f=docs/templates;/>`_ and
224 then add them to your repository docs folder and index.rst.
234 ../../../templates/sections/*
244 ../../../templates/collections/*
248 In addition to these simple templates and examples
249 there are many open source projects (e.g. Open Daylight, Open Stack)
250 that are using Sphinx and Readthedocs where you may find examples to start with.
251 Working with project teams we will continue to enhance templates here and
252 capture frequently asked questions on the developer wiki question
253 topic `documentation <https://wiki.onap.org/questions/topics/16384055/documentation>`_.
255 Each project should: decide what is relevant content; determine the
256 best way to create/maintain it in a CI/CD process; and work with the
257 documentation team to reference content from the master index and guides.
258 Consider options including filling in a template,
259 identifying existing content that can be used as is or
260 easily converted, and use of Sphinx directives/extensions to automatically
261 generate restructured text from other source you already have.
265 It's pretty common to want to reference another location in the
266 ONAP documentation and it's pretty easy to do with
267 reStructuredText. This is a quick primer, more information is in the
268 `Sphinx section on Cross-referencing arbitrary locations
269 <http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_.
271 Within a single document, you can reference another section simply by::
273 This is a reference to `The title of a section`_
275 Assuming that somewhere else in the same file there a is a section
276 title something like::
278 The title of a section
279 ^^^^^^^^^^^^^^^^^^^^^^
281 It's typically better to use ``:ref:`` syntax and labels to provide
282 links as they work across files and are resilient to sections being
283 renamed. First, you need to create a label something like::
287 The title of a section
288 ^^^^^^^^^^^^^^^^^^^^^^
290 .. note:: The underscore (_) before the label is required.
292 Then you can reference the section anywhere by simply doing::
294 This is a reference to :ref:`a-label`
298 This is a reference to :ref:`a section I really liked <a-label>`
300 .. note:: When using ``:ref:``-style links, you don't need a trailing
303 Because the labels have to be unique, it usually makes sense to prefix
304 the labels with the project name to help share the label space, e.g.,
305 ``sfc-user-guide`` instead of just ``user-guide``.
312 It is recommended that all rst content is validated by `doc8 <https://pypi.python.org/pypi/doc8>`_ standards.
313 To validate your rst files using doc8, install doc8.
317 sudo pip install doc8
319 doc8 can now be used to check the rst files. Execute as,
323 doc8 --ignore D000,D001 <file>
329 To test how the documentation renders in HTML, follow these steps:
331 Install virtual environment.
335 sudo pip install virtualenv
336 cd /local/repo/path/to/project
338 Download the doc repository.
342 git clone http://gerrit.onap.org/r/doc
344 Change directory to doc & install requirements.
349 sudo pip install -r etc/requirements.txt
351 Move the conf.py file to your project folder where RST files have been kept:
355 mv doc/docs/conf.py <path-to-your-folder>/
357 Move the static files to your project folder:
361 mv docs/_static/ <path-to-your-folder>/
363 Build the documentation from within your project folder:
367 sphinx-build -b html <path-to-your-folder> <path-to-output-folder>
369 Your documentation shall be built as HTML inside the
370 specified output folder directory.
372 .. 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.
374 .. _building-all-documentation:
378 To build the whole documentation under doc/, follow these steps:
380 Install virtual environment.
384 sudo pip install virtualenv
385 cd /local/repo/path/to/project
387 Download the DOC repository.
391 git clone http://gerrit.onap.org/r/doc
393 Update submodules, build documentation using tox & then open using any browser.
399 firefox docs/_build/html/index.html
401 .. note:: Make sure to run `tox -elocal` and not just `tox`.