A “How to” Guide for Sphinx + ReadTheDocs

This document aims to describe a standard way of creating a Python package, which can be documented using Sphinx and then consequently published to ReadTheDocs, so that it’s made available to whoever needs to read it.

Contents:

• Installation
• Folder structure
• Project setup
  • Create a repository and clone it
  • Include your source codes
• Sphinx Quickstart
• Sphinx Configuration
  • Theme configuration
  • Autodoc configuration
• Writing docstrings
  • The Sphinx docstring format
  • An example class with docstrings
  • Docstrings in VS code
• Populating our documentation
  • Building our documentation
  • Generating documentation from docstrings
  • Modifying the files generated by sphinx-apidoc
  • Adding pages to our documentation
  • Finalising the documentation
• Publishing the documentation to ReadTheDocs
  • Pushing our repository
  • Importing into ReadTheDocs
  • Changing the settings
  • Reading the docs

Indices and tables

• Index
• Module Index
• Search Page