Sphinx

Sphinx to narzędzie w Pythonie służące do generowanie dokumentacji wydane na licencji BSD.

Instalacja

Przed instalacją zaleca się stworzenie izolowanego środowiska w virtualenv. Aby zainstalować Sphinx należy skorzystać z polecenia:

pip install Sphinx

A następnie w celu wygenerowania konfiguracji (należy odpowiedzieć yes na autodoc):

sphinx-quickstart

Struktura dokumentu

Skrypt sphinx-quickstart stworzył katalog z plikiem konfiguracyjnym conf.py i z głównym dokumentem index.rst. Zasadniczym zadaniem głównego dokumentu jest serwowanie strony, która zawiera listę

The main function of the master document is to serve as a welcome page, and to contain the root of the “table of contents tree” (or toctree). This is one of the main things that Sphinx adds to reStructuredText, a way to connect multiple files to a single hierarchy of documents.

Odnośniki zewnętrzne

Sphinx