.. _documentation:

Documentation
#############

.. Attention:: à compléter!

* `Documenter son projet avec Sphinx
  <https://perso.liris.cnrs.fr/francoise.conil/documenter-son-projet-avec-sphinx/>`_

* 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 <https://www.sphinx-doc.org/en/stable/>`_;
  - `reStructuredText for Sphinx
    <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_;
  - `Awesome Sphinx <https://github.com/yoloseem/awesome-sphinxdoc>`_;
  - `apidoc <https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html>`_
    (documentation automatique).

* Conventions de documentation:

  - *Docstring convention*: :pep:`257`;
  - vérification du format: :pypi:`pydocstyle`
  - `Documenting Your Project Using Sphinx
    <https://pythonhosted.org/an_example_pypi_project/sphinx.html>`_;
  - :rtfd:`numpydoc` `Docstring standard
    <https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_;
  - `Sample doc <https://matplotlib.org/sampledoc/>`_ (matplotlib).

.. _pyyc: https://ycopin.pages.in2p3.fr/pyyc/

.. |fr| image:: ../_static/france_flag_icon.png
   :alt: Fr
.. |en| image:: ../_static/uk_flag_icon.png
   :alt: En