diff options
| author | Scott Moser <smoser@brickies.net> | 2016-11-10 16:42:43 -0500 |
|---|---|---|
| committer | Scott Moser <smoser@brickies.net> | 2016-11-10 16:48:58 -0500 |
| commit | 127f0f5076bf8e5c53dd538899199455ebc08fbc (patch) | |
| tree | b749345cefd3c003a8e7960af32d50ea98fa2de3 /doc/rtd/index.rst | |
| parent | 25c218e5659445ecf64febe03c08c6fd9ca016e6 (diff) | |
| download | vyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.tar.gz vyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.zip | |
doc: make the RST files consistently formated and other improvements.
The biggest things here are:
* move doc/sources/*/README.rst to doc/rtd/topics/datasources
This gives each datasource a page in the rtd docs, which make
it easier to read.
* consistently use the same header style throughout.
As suggested at
http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
use:
# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
“, for paragraphs
Also, move and re-format vendor-data documentation to rtd.
Diffstat (limited to 'doc/rtd/index.rst')
| -rw-r--r-- | doc/rtd/index.rst | 47 |
1 files changed, 30 insertions, 17 deletions
diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst index f8ff3c9f..90defade 100644 --- a/doc/rtd/index.rst +++ b/doc/rtd/index.rst @@ -1,32 +1,45 @@ .. _index: -===================== +.. http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html +.. As suggested at link above for headings use: +.. # with overline, for parts +.. * with overline, for chapters +.. =, for sections +.. -, for subsections +.. ^, for subsubsections +.. “, for paragraphs + +############# Documentation -===================== +############# -.. rubric:: Everything about cloud-init, a set of **python** scripts and utilities to make your cloud images be all they can be! +.. rubric:: Everything about cloud-init, a set of **python** scripts and + utilities to make your cloud images be all they can be! +******* Summary ------------------ - -`Cloud-init`_ is the *defacto* multi-distribution package that handles early initialization of a cloud instance. +******* +`Cloud-init`_ is the *defacto* multi-distribution package that handles early +initialization of a cloud instance. ---- .. toctree:: :maxdepth: 2 - topics/capabilities - topics/availability - topics/format - topics/dir_layout - topics/examples - topics/datasources - topics/logging - topics/modules - topics/merging - topics/moreinfo - topics/hacking + topics/capabilities.rst + topics/availability.rst + topics/format.rst + topics/dir_layout.rst + topics/examples.rst + topics/datasources.rst + topics/logging.rst + topics/modules.rst + topics/merging.rst + topics/vendordata.rst + topics/moreinfo.rst + topics/hacking.rst .. _Cloud-init: https://launchpad.net/cloud-init +.. vi: textwidth=78 |