Configuring Sphinx from scratch: making your own documentation and making your documentation your own

DOI

ORCID iD iconSadie Bartholomew1*
  1. Presenting author.
  2. National Centre for Atmospheric Science.
This event will be scheduled soon

In this demonstration we will build a mature documentation system from scratch for a dummy project using the Sphinx documentation generator, the infrastructure of choice for the documentation of a huge number of modern software projects, including of Python itself.

We begin with the basics: writing reStructuredText content and configuring a build to convert it into the desired output(s), taking HTML and LaTeX outputs as an example. We then cover just some of the many ways you can customise the structure, style and capability of your Sphinx project to ‘make it your own’, so it fits with the specific needs of your audience. Whether you want to setup dedicated documentation for a project, or want a home for notes on a topic, or even a book, we aim to showcase that a Sphinx project can be an easy, flexible and powerful means to store and develop your content.

This demonstration requires some familiarity with Python and the Linux shell (command line).

Language: English Prerequisites: Basic familiarity with Python and the command line License: Open source Installation instructions: https://sphinx-doc.org

Registration will open soon Software demos Download

Updated: