These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx.

このガイドでは、Sphinxを使用する方法を説明し、Sphinxのインストール、最初のSphinxプロジェクトの設定から、Sphinxが提供するいくつかの高度な機能の使用までを網羅しています。

Getting started Setting up your project and development environment Creating the documentation layout First steps to document your project using Sphinx Building your HTML documentation Building your …

The goal of this document is to give you a quick taste of what Sphinx is and how you might use it. When you’re done here, you can check out the installation guide followed by the intro to the default markup …

在本地进行开发，通常建议将 Sphinx 安装在非全局环境中（例如使用 venv 或 conda 环境）。 这将允许每个 Sphinx 项目使用独立的 Sphinx 版本和第三方扩展。

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 …

Sphinx supports various cross-referencing roles to create links to other elements in the documentation. In general, writing :role:`target` creates a link to the object called target of the type indicated by role.

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 processing.

This guide is aimed at giving a quick introduction for those wishing to develop their own extensions for Sphinx. Sphinx possesses significant extensibility capabilities including the ability to hook into almost …

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 …