Notes on documentation

Tooling

2 options:

• mkdocs or mkdocs-material (current setup)
• pdoc3

Note: Portray and Pdocs are dead (and unusable) now. Cf. these:

• https://lab.abilian.com/Tech/Tools/Documentation/
• https://lab.abilian.com/Tech/Python/Tooling/Documentation/
• https://lab.abilian.com/Tech/Python/Tooling/Documenting%20a%20Python%20API/

Norms and guidelines

• https://lab.abilian.com/Tech/Documentation/Documentation/
• https://lab.abilian.com/Tech/Documentation/READMEs/
• https://lab.abilian.com/Tech/Documentation/Tips%20on%20writing%20well/