Documentation Writing Guide

This is a short guide for documenting my investigations an discoveries as well as quick reminders for processes like installations and setups.

The aim is to have all of the documentation to be consistent and following the same conventions.

Contents:

• Project setup
• RST Primer
• Writing Style

Todo

Explain custom directives

(The original entry is located in /home/marcel/Projects/Documentation/conventions/source/setup.rst, line 51.)

Todo

Formulate unified style

(The original entry is located in /home/marcel/Projects/Documentation/conventions/source/style.rst, line 5.)

Todo

This needs attention:

| L1 Section ##########
| L2 Section **********
| L3 Section ==========
| L4 Section -----------
| L5 Section ^^^^^^^^^^^
| L6 Section """""""""""

(The original entry is located in /home/marcel/Projects/Documentation/conventions/source/primer.rst, line 254.)