Documentation¶
The problem with guides on how to write documentations are more or less cheat sheets for restructured-text which is not what I was looking for. Therefore, here are some projects which what I consider as beautiful and informative documentations.
List of example projects¶
List of Tips¶
- The level of headings in this documentation does not have to be very deep. Therefore,
only underline headings in the following order are used:
=
,-
,^
and~
.