diff options
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst b/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst index 56449beb2..edbf1e219 100644 --- a/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst +++ b/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst @@ -7,8 +7,8 @@ Converting to RST ================= -RST format is used for documentation. Other file formats can be converted to RST -with pandoc. +RST format is used for documentation. Other file formats can be converted to +RST with pandoc. .. caution:: @@ -40,53 +40,53 @@ you'd like to convert: :code:`-f` tells pandoc the input format. It should be one of the following: -+--------------------+---------------------------------------------------------------+ -| Format | Description | -+====================+===============================================================+ -|commonmark | Markdown variant | -+--------------------+---------------------------------------------------------------+ -|docbook | XML-based markup | -+--------------------+---------------------------------------------------------------+ -|docx | Microsoft Word | -+--------------------+---------------------------------------------------------------+ -|epub | Ebook format | -+--------------------+---------------------------------------------------------------+ -|haddock | Doc format produced by tool used on Haskell code | -+--------------------+---------------------------------------------------------------+ -|html | HTML | -+--------------------+---------------------------------------------------------------+ -|json | JSON pandoc AST | -+--------------------+---------------------------------------------------------------+ -|latex | Older typesetting syntax | -+--------------------+---------------------------------------------------------------+ -|markdown | Simple formatting syntax meant to produce HTML | -+--------------------+---------------------------------------------------------------+ -|markdown_github | Github flavored markdown | -+--------------------+---------------------------------------------------------------+ -|markdown_mmd | Multi-markdown flavored markdown | -+--------------------+---------------------------------------------------------------+ -|markdown_phpextra | PHP flavored markdown | -+--------------------+---------------------------------------------------------------+ -|markdown_strict | Markdown with no added pandoc features | -+--------------------+---------------------------------------------------------------+ -|mediawiki | Popular wiki language | -+--------------------+---------------------------------------------------------------+ -|native | Pandoc native Haskell | -+--------------------+---------------------------------------------------------------+ -|odt | Open document text (used by LibreOffice) | -+--------------------+---------------------------------------------------------------+ -|opml | Outline processor markup language | -+--------------------+---------------------------------------------------------------+ -|org | Org mode for Emacs | -+--------------------+---------------------------------------------------------------+ -|rst | reStructuredText | -+--------------------+---------------------------------------------------------------+ -|t2t | Wiki-like formatting syntax | -+--------------------+---------------------------------------------------------------+ -|textile | A formatting syntax similar to RST and markdown | -+--------------------+---------------------------------------------------------------+ -|twiki | Popular wiki formatting syntax | -+--------------------+---------------------------------------------------------------+ ++--------------------+----------------------------------------------------+ +| Format | Description | ++====================+====================================================+ +|commonmark | Markdown variant | ++--------------------+----------------------------------------------------+ +|docbook | XML-based markup | ++--------------------+----------------------------------------------------+ +|docx | Microsoft Word | ++--------------------+----------------------------------------------------+ +|epub | Ebook format | ++--------------------+----------------------------------------------------+ +|haddock | Doc format produced by tool used on Haskell code | ++--------------------+----------------------------------------------------+ +|html | HTML | ++--------------------+----------------------------------------------------+ +|json | JSON pandoc AST | ++--------------------+----------------------------------------------------+ +|latex | Older typesetting syntax | ++--------------------+----------------------------------------------------+ +|markdown | Simple formatting syntax meant to produce HTML | ++--------------------+----------------------------------------------------+ +|markdown_github | Github flavored markdown | ++--------------------+----------------------------------------------------+ +|markdown_mmd | Multi-markdown flavored markdown | ++--------------------+----------------------------------------------------+ +|markdown_phpextra | PHP flavored markdown | ++--------------------+----------------------------------------------------+ +|markdown_strict | Markdown with no added pandoc features | ++--------------------+----------------------------------------------------+ +|mediawiki | Popular wiki language | ++--------------------+----------------------------------------------------+ +|native | Pandoc native Haskell | ++--------------------+----------------------------------------------------+ +|odt | Open document text (used by LibreOffice) | ++--------------------+----------------------------------------------------+ +|opml | Outline processor markup language | ++--------------------+----------------------------------------------------+ +|org | Org mode for Emacs | ++--------------------+----------------------------------------------------+ +|rst | reStructuredText | ++--------------------+----------------------------------------------------+ +|t2t | Wiki-like formatting syntax | ++--------------------+----------------------------------------------------+ +|textile | A formatting syntax similar to RST and markdown | ++--------------------+----------------------------------------------------+ +|twiki | Popular wiki formatting syntax | ++--------------------+----------------------------------------------------+ Fixing the converted document ----------------------------- @@ -106,5 +106,5 @@ Previewing edits Web-based ~~~~~~~~~ -`rst.ninjs.org <http://rst.ninjs.org>`_ has an excellent RST previewing -tool that highlights RST errors with line numbers. +`Online Sphinx editor <https://livesphinx.herokuapp.com/>`_ is a RST previewing +tool. |