...
- A local one: to verify syntax highlighhighlight
- An advanced one: to check locally the generated HTML files as produced by ONAP
...
- to set up the following Python libraries.
- to configure the RST plugin
Local Python libraries
You must use Python3 version.
ONAP is using a set of Sphinx extensions to generate the documentation:
- sphinxcontrib.blockdiag
- sphinxcontrib.sphinxcontrib-needs
- sphinxcontrib.sphinxcontrib-plantuml
- sphinxcontrib.nwdiag
- sphinxcontrib.seqdiag
- sphinxcontrib.swaggerdoc
- sphinx_rtd_theme
Make sure you are in a Python 3 environment.
Install needed packages:
pip install lfdocs-conf
pip install rstcheck
pip install doc8
pip install sphinx sphinx-autobuild
pip install sphinxcontrib.-blockdiag
pip install sphinxcontrib.sphinxcontrib-needs
pip install sphinxcontrib.sphinxcontrib-plantuml
pip install sphinxcontrib.-nwdiag
pip install sphinxcontrib.-seqdiag
pip install sphinxcontrib.-swaggerdoc
pip install sphinx_rtd_theme
...
Conf Path: ${workspaceFolder}/docs
Docutils Writer: html
Docutils Writer Part: html_body
Linter: Executable Path: /usr/bin/doc8 or $VIRTUAL_ENV/bin/doc8 if you are in a python 3 virtual env (and launched Visual studio code from it)
Linter: Name: doc8Sphinxdoc8
Sphinx Build Path: /usr/local/bin/sphinx-build or $VIRTUAL_ENV/bin/sphinx-build if you are in a python 3 virtual env (and launched Visual studio code from it)Note: you need to open a Folder associated with the ONAP component
...