onap
jakarta
Home
Jakarta Release Notes
Project Specific Release Notes
ONAP Overview
ONAP Architecture
ONAP Components and Functionalities
Operations and Administration Guides
User Guides
Developer Guides
Creating Documentation
Introduction
Setting Up
Creating Restructured Text
Testing
Setting up environment
Style guide
API documentation
Converting to RST
Updates and Review
REST API Reference
Templates
Documentation Guides
onap
»
Developer Guides
»
Creating Documentation
View page source
Creating Documentation
Introduction
When is documentation required?
How do I create ONAP documentation?
Why reStructuredText/Sphinx?
Which docs should go where?
Setting Up
Setup project repositories
Branches in the DOC Project
About GIT branches
Creating Restructured Text
ReStructuredText markup conventions
Templates and Examples
Links and References
Index File
Source Files
Writing RST Markdown
Creating Indices
Jenkins Jobs
Testing
One RST File
One Project
All Documentation
Setting up environment
Prerequisites
Installing git
Configure Git
Installing git-review
Setting up gerrit
Style guide
Writing guidelines
ONAP Conventions for the Use of Sphinx Directives
API documentation
Swagger
Global API table
API Swagger
Converting to RST
Installing pandoc
Converting
Fixing the converted document
Previewing edits
Read the Docs
v: jakarta
Versions
latest
jakarta
istanbul
Downloads
On Read the Docs
Project Home
Builds