1. Presentation of the documentary system#

1.1. Sphinx & reStructuredText (RST)#

The writing format changes from ODT (LibreOffice) to RST.
Sphinx is the standard for software documentation. It’s the
docstrings format in Python.

< https://docs.python.org>- `Python`_,: `Numpy`_ < https://numpy.org/doc/stable/>, `scipy`_ < https://docs.scipy.org/doc/scipy/> (and `others < https://github.com/readthedocs-examples/awesome-read-the-docs? tab=readme-ov-file #sphinx -projects>`_…) publish their documentation in Sphinx.
-*RestructuredText is an easy-to-read, what-you-see-is-what-you-get: plaintext markup syntax*.

Description of `restructuredText with
< https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>Sphinx`_.
d8.00.01.

1.2. Preview of a document in reStructuredText#

Newton's method
=====

Principle of the method
----------------------

Newton's method is a classical method for solving
equations of the search for zero type. Let's consider a function
:math:`F` non-linear vector of the :math:`x` vector.
We are looking for the zero of this function, that is to say:

.. math:
    F (x) =0

Newton's method consists in constructing a sequence of vectors
:math:`{x}^{n}` converging on solution :math:`x`.
To find the new iterate :math:`{x}^\{n+1\}`, we approach
:math:`F({x}^\{n+1\})` by a development limited to order one
around :math:`{x}^{n}` and we express that :math:`F({x}^\{n+1\})`
must be null:

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

1.3. A small overview#

See page:external Méthode de Newton de R5.03.01.

1.4. File repository (s) RST#

The Git documentation repository contains:

in source/manual:
- files RST,
- classic tree man_u/u0/u0.00.00,
- images and figures can be found in u0.00.00/images,
a script to do everything: « . /doc_build.sh «
automatic download/installation of building requirements
the pages.

Depot address: Do git clone from the `gitlab-codeaster/doc/docaster`_ repository
Intranet: Documents with restricted access are managed in a different repository (docaster-intranet) in the source/intranet directory.