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/topics/moreinfo.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/topics/moreinfo.rst')
| -rw-r--r-- | doc/rtd/topics/moreinfo.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/rtd/topics/moreinfo.rst b/doc/rtd/topics/moreinfo.rst index b34cb7dc..9c3b7fba 100644 --- a/doc/rtd/topics/moreinfo.rst +++ b/doc/rtd/topics/moreinfo.rst @@ -1,12 +1,13 @@ -================ +**************** More information -================ +**************** Useful external references --------------------------- +========================== - `The beauty of cloudinit`_ - `Introduction to cloud-init`_ (video) .. _Introduction to cloud-init: http://www.youtube.com/watch?v=-zL3BdbKyGY .. _The beauty of cloudinit: http://brandon.fuller.name/archives/2011/05/02/06.40.57/ +.. vi: textwidth=78 |