Software Documentation using Sphinx

Overview

Teaching: 15 min
Exercises: 10 min

Questions

• What tools can we use to document our software package?

• How to make software documentation public?

Objectives

What options do we have for software documentation

Using Sphinx

Installing Sphinx

Poetry installation instructions.

We can install Poetry much like any other Python distributable package, using pip:

$ source venv/bin/activate
$ pip3 install poetry

To test, we can ask where Poetry is installed:

$ which poetry

/home/alex/InterPython_Workshop_Example/venv/bin/poetry

Creating documentation

Optional Exercise: Enhancing our Package Metadata

An exercise

Key Points