Sphinx# Sphinx auto Doc static site tutorial Environment setup Prerequisites Creating your project Using GitHub Codespaces (Recommended) On your computer Using a virtual environment Getting started with Sphinx Starting with Sphinx Previewing your docs reStructuredText basics The index.rst file Heading Table of contents tree Creating a section Image Documenting your API Generating HTML docs from docstrings Selecting a theme Using a built-in theme Using a PyPI Theme Adding a favicon Hosting on GitHub Pages Creating a gh-pages branch Cleaning the HTML files Disabling Jekyll Hosting the documentation Automating documentation updates Creating a simple GitHub Action Deploying your docs automatically The complete “Publish Sphinx Documentation” GitHub Action Versioning Using sphinx-multiversion Configuring the site’s sidebar Generating different versions for your docs Choosing a default version Selecting Branches/Tags of Interest Automating versioning The updated “Publish Sphinx Documentation” GitHub Action using sphinx-multiversion Glossary Further reading Useful extensions to check out
