diff options
| author |   Rich Bennett <rb2745@att.com> | 2018-05-31 11:44:29 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2018-05-31 11:51:07 -0400 |
| commit | 2b99cfe91bc6b0fb1d61fe4703ec61741563081d (patch) | |
| tree | 58a8d6c2ba97a1d70a414c83715fa4bea18abdd0 /docs/guides/onap-developer/how-to-use-docs/converting-formats.rst | |
| parent | e4ce69915138d4830bad9fa069ce3013a1a82d29 (diff) | |
Initial commit to DOC Project Beijing branch
Sphinx configuration release name and copyright
gitreview default branch
latests documentation guide with branch integration options
temporary under construction and guidance for final content message
Change-Id: Id2e6738b199c2b8aab33a097afcc653b951a77f3
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. |