Sphinx is community supported and welcomes contributions from anybody. The sections below should help you get started joining the Sphinx community as well as contributing.
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 have a directory containing a bunch of reStructuredText or Markdown documents, Sphinx can generate a series of HTML files, a PDF file (via LaTeX), man pages and much more. Sphinx ...
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 advanced features Sphinx provides out-of-the-box. If you are looking for guidance on extending Sphinx, refer to Extending Sphinx.
The Basics Sphinxのインストール PyPI package Conda package OS-specific package manager Linux macOS Windows Docker Installation of the latest development release ソースからインストール Getting started ドキュメントのソースの準備 ドキュメント構造の定義 コンテンツの追加 ビルドの実行 オブジェクトのドキュメントを書く enumerate ...
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 available by running
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 well as autogenerated API documentation. The tutorial is aimed towards Sphinx newcomers willing to learn the fundamentals of how projects are created and structured. You will create a ...