Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Context

ONAP doumentation documentation is using reStructuredText (RST) as input format.

...

  • A local one: to verify syntax hightlighhighligh
  • An advanced one: to check loally locally the generated HTML files as produced by ONAP

Basic Local

...

Environnement

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.

...

As a result, we can see on your environment the RST key words highlighted and some spelling errors as illustrated on the following picture:

Advanced Local

...

Environment

It is possible to preview the HTML produced by ONAP documentation using the Preview button  on the top-right corner.

...