This repository explores the Sphinx documentation system by investigating its capabilities, quirks, and possibilities. Most of the explorations use the Sphinx Playground organization's example repositories, which you're welcome to experiment with yourself.
The following flexible categories organize the content, with documents occasionally moving from one category to another as explorations develop and new information comes to light:
- Guides — Explanations of Sphinx features and how they work, through tutorials, step-by-step instructions, or overviews.
- Limbo — Explorations that don't currently fit into another category.
- Practical — Explorations that produce techniques, solutions, or patterns suitable for real-world use.
- Shenanigans — Playful explorations of unusual ideas, unexpected possibilities, and things that might seem impractical or downright outlandish.
Sphinx immediately stole my heart as an amazing system with pretty well limitless possibilities. This little corner of the internet hopes to show others how to play with Sphinx and perhaps also fall in love with it.
If you have comments, corrections, or suggestions, feel free to start or join a discussion.
- Sphinx Framework Layout Comparisons — a comprehensive comparison of Sphinx framework layouts, detailing single and split repository structures along with examples.
- TODO 👀
- TODO 👀
- TODO 👀
Unless otherwise noted, all original content in this repository is licensed under the MIT License. Individual articles include their own licensing information so that they can be used independently of this repository.