[SeasonOfDocs] reStructureText Quick Starts and References

[Jared Morgan]

I asked around on Write the Docs in the Sphinx channel and got some useful
links to abridged rST usage guides.

http://docutils.sourceforge.net/docs/user/rst/quickstart.html  is the first
one and takes the form of an abridged version of
http://docutils.sourceforge.net/docs/user/rst/quickref.html#section-structure

Both are recommended by writers who need a quick reminder of syntax.

One thing I will say is that rST looks quite similar to AsciiDoc, with some
notable differences.

The way you do headings in AsciiDoc is like this:

= Heading 1
== Heading 1.1
=== Heading 1.1.1

whereas in rST it is"

Chapter 1 Title
===============

Section 1.1 Title
-----------------

Subsection 1.1.1 Title
~~~~~~~~~~~~~~~~~~~~~~


The only thing that grinds my gears about that is that you seem to have to
stuff around with needless decoration to get the headings to display. Those
folks who use writing IDEs like Atom an MS Code, are there good libraries
that take away some of these rough edges?

Jared Morgan
M: +61413005479
Google+ <https://plus.google.com/u/0/117309635670089895654/posts/p/pub> |
Twitter <http://twitter.com/!#/jaredmorgs> | Facebook
<http://facebook.com/jaredmorgs>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190606/2aa81d21/attachment.html>