All Images

Introduction

Documentation examples

Figure 1

A screenshot of the user guide for the ggplot2 ggplot function in RStudio.
The RStudio Help panel for the ggplot function.

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

MkDocs home page with default theme.
The MkDocs home page for our documentation site

Figure 2

API reference page.
Python documentation strings rendered as HTML by mkdocstrings

Command line interfaces