python-sphinx
Écrire des docstrings en utilisant l'autodoc

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

Introduction

Sphinx permet l’inclusion de docstrings dans la documentation à l’aide de l’ extension Autodoc fournie avec le package. Cette documentation vous montrera comment formater vos docstrings et comment les inclure dans votre documentation.

Installation de l'extension d'autodoc

Ajoutez le module d'autodoc dans la list extensions présente dans le fichier conf.py à la racine de votre documentation:

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

Ajouter votre chemin de code dans la configuration du sphinx

Autodoc doit importer vos modules pour fonctionner.

Vous pouvez inclure votre chemin de code dans votre fichier conf.py

Par exemple:

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

Modified text is an extract of the original Stack Overflow Documentation

Sous licence CC BY-SA 3.0

Non affilié à Stack Overflow