4. Documentation

Attention

TODO

Pour un exemple de mise en oeuvre de la documentation, voir le code test pyyc.

• Outils de documentation, ou comment transformer automagiquement un code-source bien documenté en une documentation fonctionnelle.

  • Sphinx;

  • reStructuredText for Sphinx;

  • Awesome Sphinx;

  • apidoc (documentation automatique).

• Conventions de documentation:

  • Docstring convention: PEP 257;

  • vérification du format: pydocstyle

  • Documenting Your Project Using Sphinx;

  • numpydoc Docstring standard;

  • Sample doc (matplotlib).

Notes de bas de page