++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Créer un projet documenté
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. include:: volabid.rst

:Date de création: 18/04/2023
:Date dernière maj: 10/05/2023

====================================================================================================
Configuration requise
====================================================================================================
.. index::
    single: pip




.. index::
    single: Python

Python


.. index::
    single: Sphinx


Sphinx

Vérifier tous les paquets Python installés

 * C:\
 * pip list

.. index::
    single: Visual Studio Code

J'utilise aussi Visual Studio Code

====================================================================================================
Démarche
====================================================================================================
 1. Créer le dossier du projet "creation-docs"
 2. Se positionner dans ce dossier 
 3. Lancer cmd
 4. lancer sphinx-quickstart
 5. Création automatique des dossiers build et source
 6. Se positionner dans le dossier "creation-doc"
 7. lancer cmd
 8. Lancer make html

====================================================================================================
Tables et index
====================================================================================================

* :ref:`genindex`

* :ref:`search`


====================================================================================================
Informations
====================================================================================================

`Installations de Python et Sphinx`_

.. _`Installations de Python et Sphinx` : https://www-sphinx--doc-org.translate.goog/en/master/usage/installation.html?_x_tr_sl=en&_x_tr_tl=fr&_x_tr_hl=fr&_x_tr_pto=sc


`Sphinx-doc`_ 

.. _`Sphinx-doc` : https://deusyss.developpez.com/tutoriels/Python/SphinxDoc/#LV-B-1

`A ReStructured Text Primer`_ 

.. _`A ReStructured Text Primer` : http://docutils.sourceforge.net/docs/user/rst/quickstart.html

`Thèmes page html Sphinx`_

.. _`Thèmes page html Sphinx` : https://sphinx--themes-org.translate.goog/?_x_tr_sl=en&_x_tr_tl=fr&_x_tr_hl=fr&_x_tr_pto=sc


`Visual Studio Code`_

.. _`Visual Studio Code` : https://code.visualstudio.com


Todo ; regarder les directives sphinx
cloud







====================================================================================================
Weblinks
====================================================================================================

.. target-notes::