/
APPC Documentation

APPC Documentation

Resources for creating ONAP documents

Latest ONAP Documents:

ONAP Documentation Creation:

Pandoc:

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



Example index.rst:
.. This work is licensed under a Creative Commons Attribution 4.0 International License. APPC Documentation Repository ----------------------------- .. toctree:: :maxdepth: 2 APPC LCM API Guide/APPC LCM API Guide APPC Client Library Guide/APPC Client Library Guide APPC Logging Guide/APPC Logging Guide APPC User Guide/APPC User Guide APPC OAM API Guide/APPC OAM API Guide APPC CDT Guide/APPC CDT Guide
conf.py
  • Required to test the rst using Sphinx

  • Must be copied into the docs root directory after clo0ning from gerrit

  • Must be removed from docs root before submitting changes back to gerrit

    • (Won’t necessarily hurt anything but it’s just messy)

Using Sphinx to generate test html

  • Once rst updates are made you can generate sample html using sphinx:


sphinx-build -b html /home/myhome/appc/docs /home/myhome/test
  • Sample output of html generator:



Resulting html will be displayed:



Related content

RST Document Generation Tutorial
RST Document Generation Tutorial
More like this
ONAP DDF Documentation session
ONAP DDF Documentation session
More like this
DOC Comparison of Open Source Documentation Systems: ReStructuredText and Diátaxis
DOC Comparison of Open Source Documentation Systems: ReStructuredText and Diátaxis
More like this
Using Papyrus 2020-06 for Modeling
Using Papyrus 2020-06 for Modeling
More like this
Documenting ONAP Architecture (New)
Documenting ONAP Architecture (New)
More like this
Using Redoc to Generate API Reference Documentation
Using Redoc to Generate API Reference Documentation
More like this