python-sphinx
Docstrings schrijven met autodoc
Zoeken…
Invoering
Met Sphinx kunnen docstrings in de documentatie worden opgenomen met behulp van de autodoc-extensie die bij het pakket wordt geleverd. Deze documentatie laat zien hoe u uw documenten opmaakt en hoe u ze in uw documentatie kunt opnemen.
De autodoc-extensie installeren
Voeg de AutoDoc module in de extensions list aanwezig is in het conf.py bestand op de root van je documentatie:
extensions = [
'sphinx.ext.autodoc',
...
]
Uw codepad toevoegen in de Sphinx-configuratie
Autodoc moet uw modules importeren om te werken.
U kunt uw conf.py in uw conf.py bestand.
Bijvoorbeeld:
import os
sys.path.insert(0, os.path.abspath('../src'))
Modified text is an extract of the original Stack Overflow Documentation
Licentie onder CC BY-SA 3.0
Niet aangesloten bij Stack Overflow