APPC Documentation

Resources for creating ONAP documents

Latest ONAP Documents:

• http://onap.readthedocs.io/en/latest/index.html

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.
  • http://docutils.sourceforge.net/rst.html
  • http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Pandoc:

• Used to convert Word documents to rst
• https://pandoc.org

Pandoc – Converting Word Docs to rst

Pandoc installation:

• https://pandoc.org/installing.html

Running pandoc:

pando	c -s mydoc.docx -t rst -o mydoc.rst

Testing – Testing rst files using SPHINX

SPHINX (Python Doc Generator)

Sphinx Docs:

• http://www.sphinx-doc.org/en/master

Sphinx and rst:

• http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Install Sphinx:

• http://www.sphinx-doc.org/en/master/usage/installation.html

index.rst

• Must be in the docs root directory

.. 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