python-sphinx
Scrivere docstrings usando autodoc

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

introduzione

Sphinx consente l'inclusione di docstrings nella documentazione utilizzando l' estensione autodoc che viene fornita con il pacchetto. Questa documentazione ti mostrerà come formattare le tue docstring e come includerle nella tua documentazione.

Installazione dell'estensione autodoc

Aggiungi il modulo conf.py list extensions presente nel file conf.py nella radice della documentazione:

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

Aggiunta del percorso del codice nella configurazione della sfinge

Autodoc ha bisogno di importare i tuoi moduli per funzionare.

È possibile includere il percorso del codice nel file conf.py

Per esempio:

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

Modified text is an extract of the original Stack Overflow Documentation

Autorizzato sotto CC BY-SA 3.0

Non affiliato con Stack Overflow