Introduction


Documentation examples


Writing README files


Figure 1

A screenshot of a GitHub repository with a drop-down navigation menu on the readme text box.
This repository has a README file with chapters, making navigation easier.

Documentation strings


Code readability


Contributor guidance


Documentation sites


Figure 1

The Sphinx homepage for our documentation site
The Sphinx homepage for our documentation site

Figure 2

Python documentation string rendered as HTML
Python documentation string rendered as HTML

Command line interfaces