python-sphinx
Skriva docstrings med autodoc
Sök…
Introduktion
Sphinx tillåter införande av dokument i dokumentationen med den autodoc-förlängningen som medföljer paketet. Den här dokumentationen visar hur du formaterar dina dokument och hur du inkluderar dem i din dokumentation.
Installera autodoc-förlängningen
Tillsätt Autodoc modulen i extensions list finns i conf.py fil i roten på din dokumentation:
extensions = [
'sphinx.ext.autodoc',
...
]
Lägga till din kodväg i sfinxkonfigurationen
Autodoc måste importera dina moduler för att fungera.
Du kan inkludera din conf.py i din conf.py fil.
Till exempel:
import os
sys.path.insert(0, os.path.abspath('../src'))
Modified text is an extract of the original Stack Overflow Documentation
Licensierat under CC BY-SA 3.0
Inte anslutet till Stack Overflow