.. _d8.00.00-presentation:

Présentation du système documentaire
====================================


Sphinx & reStructuredText (RST)
-------------------------------

-  Le format de rédaction passe de ODT (LibreOffice) à RST.
-  Sphinx est le standard pour la documentation de logiciels. C’est le
   format des *docstrings* en Python.
-  `Python <https://docs.python.org>`_,
   `NumPy <https://numpy.org/doc/stable/>`_,
   `SciPy <https://docs.scipy.org/doc/scipy/>`_ (et
   `autres <https://github.com/readthedocs-examples/awesome-read-the-docs?tab=readme-ov-file#sphinx-projects>`_...)
   publient leur documentation en Sphinx.
-  *reStructuredText is an easy-to-read, what-you-see-is-what-you-get
   plaintext markup syntax*.
-  Description de `reStructuredText avec
   Sphinx <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_.
-  :ref:`d8.00.01`.


Aperçu d’un document en reStructuredText
----------------------------------------

.. code-block:: text

   Méthode de Newton
   =================

   Principe de la méthode
   ----------------------

   La méthode de Newton est une méthode classique de résolution des
   équations du type recherche de zéro. Considérons une fonction
   vectorielle :math:`F` non-linéaire du vecteur :math:`x`.
   On cherche le zéro de cette fonction, c'est à dire:

   .. math::
       F(x)=0

   La méthode de Newton consiste à construire une suite de vecteurs
   :math:`{x}^{n}` convergeant vers la solution :math:`x`.
   Pour trouver le nouvel itéré :math:`{x}^\lbrace n+1\rbrace`, on approche
   :math:`F({x}^\lbrace n+1\rbrace )` par un développement limité à l'ordre un
   autour de :math:`{x}^{n}` et on exprime que :math:`F({x}^\lbrace n+1\rbrace )`
   doit être nul:

   .. math::
       0=F({x}^{n+1\rbrace ) \approx F({x}^{n})+{F}^{'}({x}^{n})({x}^{n+1\rbrace -{x}^{n})


Un petit aperçu
---------------

Voir la page :external:ref:`Méthode de Newton de R5.03.01 <r5.03.01-principe-newton>`.


Dépôt(s) des fichiers RST
-------------------------

Le dépôt Git de la documentation contient :

-  dans ``source/manuals`` :

   -  les fichiers RST,
   -  arborescence classique ``man_u/u0/u0.00.00``,
   -  images et figures se trouvent dans ``u0.00.00/images``,
-  un script à tout faire : ``./doc_build.sh``
-  téléchargement/installation automatique des prérequis pour construire
   les pages.

Adresse du dépôt
    Faire ``git clone`` du dépôt `gitlab-codeaster/doc/docaster`_

Intranet
    Les documents à accès restreint sont gérés dans un dépôt différent
    (``docaster-intranet``) dans le répertoire ``source/intranet``.


.. include:: ../../../../../_cache/external_refs.rst