diff options
| author |   Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-09-11 12:48:44 +0200 |
|---|---|---|
| committer | Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-09-11 12:48:44 +0200 |
| commit | bb258d5be6346d7ca71e4aaff8676a054ed6fde8 (patch) | |
| tree | 011bd3e72fa2e021b8eb93a0f6d089342d21f10c /docs/guides/onap-developer/how-to-use-docs | |
| parent | 3f17abe875d2fb008d60c06aaeb6c2d533467466 (diff) | |
Intro paragraph added to Coverting to RST
Some introductory information has been added to Converting to RST chapter of documentation guide.
Issue-ID: DOC-666
Change-Id: Ic488145c995c40a507a9bb6759c9263a4f62a9b8
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/converting-formats.rst | 8 |
1 files changed, 8 insertions, 0 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 835a9c5a2..56449beb2 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 @@ -7,6 +7,14 @@ Converting to RST ================= +RST format is used for documentation. Other file formats can be converted to RST +with pandoc. + +.. caution:: + + Always check the output text after conversion. For the most common errors, + see section Fixing the converted document. + Installing pandoc ----------------- |