Techwriter at work blog.

Living and writing documentation at Documatt, small team of programmers that do write documentation too.

reStructuredText and Sphinx guide¶

If you starting writing in reStructuredText, you will quickly find it’s not always intuitive. In this Sphinx and reStructuredText guide, you’ll find explanation in plain English of syntax, elementary concepts and important pitfalls to avoid.

Basics

Block elements

Sections – structuring document
Admonitions
- Attention
- Caution
- Danger
- Error
- Hint
- Important
- Note
- Tip
- Warning
- Generic Admonition