diff options
| author |   Rich Bennett <rb2745@att.com> | 2018-05-31 08:40:36 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2018-05-31 08:47:54 -0400 |
| commit | d504dc8a03a9e885056980daa39cfddfa720305e (patch) | |
| tree | ac1d77c09457f16f6306652942ffe7bf37ea4542 /docs/guides/onap-developer/how-to-use-docs/converting-formats.rst | |
| parent | 795452f4608f6145bec3ea181bae51da1b59d17a (diff) | |
Updates to How To Create Documentation
Integrating with doc project named release branch
Code review of verify job console and html build
How to use Read Docs URLs
Doc8, formating, and reference link corrections
Change-Id: If8ba97632045ec9542fd4bf1b2213a1bac5fd61d
Issue-ID: DOC-270
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/converting-formats.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/converting-formats.rst | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst b/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst index 5321a18df..835a9c5a2 100644 --- a/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst +++ b/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst @@ -1,4 +1,6 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. .. _converting-to-rst: @@ -8,12 +10,17 @@ Converting to RST Installing pandoc ----------------- -Pandoc is a powerful document-transformation utility. We'll use it to do simple conversions, but it is capable of much more. Visit the `pandoc website <http://pandoc.org/installing.html>`_ for installation instructions for your platform. +Pandoc is a powerful document-transformation utility. We'll use it to +do simple conversions, but it is capable of much more. Visit +the `pandoc website <http://pandoc.org/installing.html>`_ for +installation instructions for your platform. Converting ---------- -Using a terminal, navigate to the directory containing the documents you wish to convert. Next, issue the following command for each file you'd like to convert: +Using a terminal, navigate to the directory containing the documents +you wish to convert. Next, issue the following command for each file +you'd like to convert: :code:`pandoc -s --toc -f <from format> -t rst myfile.<from format>` @@ -76,7 +83,9 @@ Using a terminal, navigate to the directory containing the documents you wish to Fixing the converted document ----------------------------- -How much you'll need to fix the converted document depends on which file format you're converting from. Here are a couple of things to watch out for: +How much you'll need to fix the converted document depends on which file +format you're converting from. Here are a couple of things to watch out +for: 1. Multi-line titles need to be converted to single line 2. Standalone "**" characters @@ -89,7 +98,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. - - - +`rst.ninjs.org <http://rst.ninjs.org>`_ has an excellent RST previewing +tool that highlights RST errors with line numbers. |