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

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

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

Part of tutorial

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

Part of tutorial

Let's change the look on the website with custom templates.

Part of tutorial

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

Part of tutorial

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

Part of tutorial

Rich structure and linking, between sites.

Part of tutorial

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

Part of tutorial

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

Part of tutorial

Adjust Sphinx knobs using the configuration file.