/
APPC Documentation
APPC Documentation
Resources for creating ONAP documents
Latest ONAP Documents:
ONAP Documentation Creation:
http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/index.html
Readthedocs docs are saved and loaded in rst format.
Pandoc:
Used to convert Word documents to rst
Pandoc – Converting Word Docs to rst
Pandoc installation:
Running pandoc: (note: the embedded image will be created under ./media dir)
Running Pandoc
pandoc --extract-media=. -s mydoc.docx -t rst -o mydoc.rst
Testing – Testing rst files using SPHINX
SPHINX (Python Doc Generator)
Sphinx Docs:
Sphinx and rst:
Install Sphinx:
index.rst
Must be in the docs root directory