onap
latest
Home
Frankfurt Release Notes
ONAP Overview
ONAP Architecture
ONAP components and functionalities
Operations and Administration Guides
User Guides
Developer Guides
Tutorials
Creating Documentation
Introduction
Style guide
Setting Up
Creating Restructured Text
Testing
API documentation
Converting to RST
Addendum
Updates and Review
REST API Reference
VNF and PNF Requirements and Guidelines
All Active Projects
onap
Report Issue
Docs
»
Developer Guides
»
Creating Documentation
View page source
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
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.