Documentation Overview

Overview

Teaching: 0 min
Exercises: 0 min

Questions

• How do I document my project?

Objectives

• Learn how to set up documentation

Documentation used to require learning RestructureText (sometimes referred to as ReST / RST), but today we have great choices for documentation in markdown, the same format used by GitHub, Wikipedia, and others. You should select one of the two major documentation toolchains, sphinx or mkdocs.

The following episodes cover each of those.

Key Points

• Sphinx or MkDocs are both good for documentation