Creating Documentation

• Introduction
  • Why reStructuredText/Sphinx?
  • Which docs should go where?
• Style guide
  • Getting started
  • Writing guidelines
  • ONAP Conventions for the Use of Sphinx Directives
• Setting Up
  • Setup project repositories
  • Branches in the DOC Project
  • About GIT branches
• Creating Restructured Text
  • Templates and Examples
  • Links and References
• Testing
  • One RST File
  • One Project
  • All Documentation
• API documentation
  • Swagger
  • Global API table
  • API Swagger
• Converting to RST
  • Installing pandoc
  • Converting
  • Fixing the converted document
  • Previewing edits
• Addendum
  • Index File
  • Source Files
  • Writing RST Markdown
  • Creating Indices
  • Jenkins Jobs
  • Read The Docs URLs