Context
ONAP doumentation is using reStructuredText (RST) as input format.
RST files are then translated to HTML file using Sphinx Python utility and are then uploaded to the readthedoc web site based on a dedicated Jenkins Job
ONAP is using a set of additional extensions to generate the documentation:
Basic Local Envionnement
Many tools are available to write RST files. We propose a solution based on VisualStudioCode that includes a large number of plugins to check that your RST files are correct.
The VisualStudioCode is available here
The useful plugins to add are the following:
As a result, we can see on your environment the RST key words and some spelling errors as illustrated on the following picture:
Advanced Local Environnement
It is possible to preview the HTML produced by ONAP documentation using the Preview button from the RST extension.
However, it requires some local configuration on your desktop and to set up the following Python libraries:
In addition, it is important to configure the RST plugin with the following parameter: