This playground provides examples of using Sphinx for documentation, focusing on two basic repository layouts: keeping your content and its Sphinx files together in one repository or splitting them across two repositories.
You'll find these three example repositories to explore:
- sphinx-single: a single repository containing both the project and Sphinx
- sphinx-split-guest: a repository for the content in a split-repository layout
- sphinx-split-host: a repository for Sphinx in a split-repository layout
Download or clone the examples, explore their contents, change things, and experiment to your heart's content.
- Want some guidance? Visit my Sphinx TIL collection, where you'll find explanations, examples, and instructions to help you get started.
- Need additional help using the examples or exploring an automated solution for your project? Start a discussion in any of the repositories.
Work in progress: This repository is being prepared for the initial release. Its contents and configuration may change until the first version is tagged.
