Getting started — Sphinx documentation
Much of Sphinx’s power comes from the richness of its default plain-text markup format, reStructuredText, along with its significant extensibility capabilities. The goal of this document is to give you a quick taste of what Sphinx is and how you might use it.
Sphinx — Sphinx documentation
Create intelligent and beautiful documentation with ease. 📝 Rich Text Formatting. Author in reStructuredText or MyST Markdown to create highly structured technical documents, including tables, highlighted code blocks, mathematical notations, and more. 🔗 Powerful Cross-Referencing.
Using Sphinx — Sphinx documentation
This guide serves to demonstrate how one can get started with Sphinx and covers everything from installing Sphinx and configuring your first Sphinx project to using some of the advanced features Sphinx provides out-of-the-box.
Installing Sphinx — Sphinx documentation
Installing Sphinx¶ Sphinx is a Python application. It can be installed in one of the ways described below. Installation methods. PyPI package. Conda package. OS-specific package manager. Linux. macOS. Windows. Docker. Installation of the latest development release. Installation from source. After installation, you can check that Sphinx is ...
Build your first project — Sphinx documentation
In this tutorial you will build a simple documentation project using Sphinx, and view it in your browser as HTML. The project will include narrative, handwritten documentation, as well as autogenerated API documentation.
Getting started — Sphinx documentation
Then from the command line, run the following command: (.venv) $ sphinx-quickstart docs. This will present to you a series of questions required to create the basic directory and configuration layout for your project inside the docs folder. To proceed, answer each question as follows:
reStructuredText Primer — Sphinx documentation
reStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to provide authors with enough information to author documents productively.
Directives — Sphinx documentation
While Docutils provides a number of directives, Sphinx provides many more and uses directives as one of the primary extension mechanisms. See Domains for roles added by domains.
Configuration — Sphinx documentation
The configuration file is executed as Python code at build time (using importlib.import_module(), with the current directory set to the configuration directory), and therefore can execute arbitrarily complex code. Sphinx then reads simple names from the file’s namespace as its configuration.
Templating — Sphinx documentation
The default templating language in Sphinx is Jinja. It’s Django/Smarty inspired and easy to understand. The most important concept in Jinja is template inheritance, which means that you can overwrite only specific blocks within a template, customizing it while …