Sphinx

Sphinx

Python static site generator for documentation and more

Sphinx is the long-used tool in the Python community and beyond for richly-organized documentation. It helps power Read The Docs.

tutorial

Static Sites With Sphinx and Markdown
Sphinx is great for docs. But it's also great for information-rich websites. With MyST, you can use Markdown with Sphinx.

Part of tutorial

Advanced Usage
MyST has a lot more to offer than just Markdown-in-Sphinx.

Part of tutorial

Customizing Your Site
Adjust Sphinx knobs using the configuration file.

Part of tutorial

Making a New Site Design
Let's change the look on the website with custom templates.

Part of tutorial

Linking Between Sites with Intersphinx
Rich structure and linking, between sites.

Part of tutorial

Documenting Code
Pages which include source code, either directly or linking to modules.

Part of tutorial

Sphinx Setup
Make a project and virtual environment with dependencies, then make a simple Sphinx website.

Part of tutorial

More Authoring
Simple Markdown stuff is cool. The cool Markdown stuff is double cool.

Part of tutorial

Simple Markdown in Sphinx
Markdown is a simple formatting language. Let's see it in use in Sphinx.

Part of tutorial

Linking
Sphinx turns links into structure, which turns out to be very valuable.