Tutorials — Sphinx documentation

GitHub Expand Sphinx Navigation Documentation » Extending Sphinx » Tutorials The Basics Installing Sphinx Getting started Build your first project User guide Using Sphinx Extending Sphinx Tutorials Extending syntax with roles and directives Extending the build process Adding a reference domain Developing autodoc extensions How-tos HTML theme development Sphinx API LaTeX customization Community Get support Contribute to Sphinx Sphinx FAQ Sphinx authors Reference Command-line tools Configuration Extensions reStructuredText Glossary Changelog Projects using Sphinx Tutorials¶ Extending syntax with roles and directives Overview Setting up the project Writing the extension Using the extension Further reading Extending the build process Overview Prerequisites Writing the extension Using the extension Further reading Adding a reference domain Overview Prerequisites Writing the extension Using the extension Further reading Developing autodoc extensions Overview Prerequisites Writing the extension Using the extension Further reading Previous Extending Sphinx Next Extending syntax with roles and directives © Copyright 2007-2026, the Sphinx developers. Created using Sphinx 9.3.0.