Sphinx Cheat Sheet

< Blog

A quick reference to Sphinx

Created on: 2020-04-13

Tag: cheat_sheet

Install

to install Sphinx:

pip install Sphinx

source: https://www.sphinx-doc.org/en/stable/usage/installation.html#installation-from-pypi

Getting started

to get started we will use the sphinx-quickstart tool. To use it just run:

sphinx-quickstart

Now Sphinx will ask a series of question. Answer them to fit your preference and you are ready to write documentation.

source: https://www.sphinx-doc.org/en/stable/usage/quickstart.html#setting-up-the-documentation-sources

Source