Sphinx — Sphinx documentation
Sphinx ¶ Create intelligent and beautiful documentation with ease 📝 Rich Text Formatting Author in reStructuredText or MyST Markdown to create highly structured technical documents, including …
Getting started — Sphinx documentation
Getting started ¶ Sphinx is a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. That is, if you …
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 …
Using Sphinx — Sphinx documentation
Using Sphinx ¶ 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 …
Sphinx documentation contents
Sphinx documentation contents The Basics Installing Sphinx PyPI package Conda package OS-specific package manager Linux macOS Windows Docker Installation of the latest development release …
Build your first project — Sphinx documentation
Build your first project ¶ 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 …
Extensions — Sphinx documentation
Extensions ¶ Since many projects will need special features in their documentation, Sphinx allows adding “extensions” to the build process, each of which can modify almost any aspect of document …
reStructuredText Primer — Sphinx documentation
reStructuredText Primer ¶ reStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to …
Projects using Sphinx — Sphinx documentation
Theses produced using Sphinx ¶ “Content Conditioning and Distribution for Dynamic Virtual Worlds” “The Sphinx Thesis Resource” Projects integrating Sphinx functionality ¶ Read the Docs, a software …
Configuration — Sphinx documentation
Configuration ¶ The configuration directory must contain a file named conf.py. This file (containing Python code) is called the “build configuration file” and contains (almost) all configuration needed to …