Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ONAP Guidance on Documentation Creating

ONAP has requested to create documentation based on reStructuredText (RST) format to ease the creation and management of the documentations, the guidance can be found at Documentation Creation Guide.

...

The most popular one is Pandoc: https://pandoc.org/, which provides a command line tool for Windows, Linux, MacOS for documentation conversion.

Please follow the install guide to get the tool ready and the manual to use the tool.

The simplest way to use it after installation is to find the document you want to convert in the command line, and execute: pandoc -t rst  SOURCE_FILE.docx -o OUTPUT_FILE.rst

There's also a tutorial video available describing how to install pandoc and use it. 

...