Guide to reStructuredText and Sphinx¶
Example based gentle reference of the reStructuredText and Sphinx syntax, directives, roles and common issues. It demonstrates almost all the markup making it also good for testing Sphinx themes. Free and open-source.
source code: https://github.com/documatt/sphinx-restructuredtext-reference where issues and contributions are welcome
reStructuredText and Sphinx Reference is a showcase of Sphinx documentation project possibilities. It demonstrates almost all standard reStructuredText syntax with Sphinx additions.
reStructuredText and Sphinx Reference is useful if you are creating a custom Sphinx HTML theme and want to be sure your theme style doesn’t forgot to style some part of Sphinx generated HTML.
Checkout also my Sphinx Themes Collection suitable both for documentation and prose.
reStructuredText and Sphinx Reference is open source licensed under MIT.
Project icon by Pixabay.