diff options
| author |   Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-09-25 12:23:47 +0200 |
|---|---|---|
| committer | Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-10-01 12:34:33 +0200 |
| commit | a2eb2e21c26309f52c2942ef6515ce708540c78b (patch) | |
| tree | ca17e50acdbe04cb062fc48d27a8d0448efd27e7 /docs/guides/onap-developer/how-to-use-docs/setting-up.rst | |
| parent | c847e4ef2a410ea91a4ec49c7c15bc19b87051ac (diff) | |
Moving section from style guide to other chapters
Moved 2 sections to Introduction.
Moved 1 section to Setting up/Creating Restructured Text.
Issue-ID: DOC-670
Change-Id: I2b147d7e54f1b8e5f10521734b86531e66ad2c68
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/setting-up.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/setting-up.rst | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst index 91f530983..d9f87af51 100644 --- a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst +++ b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst @@ -295,6 +295,15 @@ release. In this context: Creating Restructured Text ========================== +ReStructuredText markup conventions +----------------------------------- +For detailed information on ReStructuredText and how to best use the format, +see: + +- `ReStructured Text Primer <http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ +- `ReStructured Text Quick Reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ + + Templates and Examples ---------------------- Templates are available that capture the kinds of information @@ -477,8 +486,8 @@ Change directory to doc & install requirements. .. warning:: - Just follow the next step (copying conf.py from Doc project to your project) - if that is your intention, otherwise skip it. Currently all projects should already have a conf.py file. + Just follow the next step (copying conf.py from Doc project to your project) + if that is your intention, otherwise skip it. Currently all projects should already have a conf.py file. Through the next step, this file and potential extensions in your project get overriden. Copy the conf.py file to your project folder where RST files have been kept: |