python-sphinx
Pisanie dokumentów za pomocą autodoc

C++ CSS Django Flask Git HTML JavaScript latex MATLAB Language Python Language

Wprowadzenie

Sphinx pozwala na dołączanie dokumentów do dokumentacji przy użyciu rozszerzenia autodoc, które jest dostarczane z pakietem. Ta dokumentacja pokaże ci, jak sformatować swoje dokumenty i jak je uwzględnić w dokumentacji.

Instalowanie rozszerzenia autodoc

Dodaj moduł autodoc do list extensions znajdującej się w pliku conf.py w katalogu głównym dokumentacji:

extensions = [
    'sphinx.ext.autodoc',
     ...
]

Dodanie ścieżki do kodu w konfiguracji sfinksa

Autodoc musi zaimportować moduły do pracy.

Możesz dołączyć ścieżkę do swojego pliku conf.py

Na przykład:

import os
sys.path.insert(0, os.path.abspath('../src'))

Modified text is an extract of the original Stack Overflow Documentation

Licencjonowany na podstawie CC BY-SA 3.0

Nie związany z Stack Overflow