Contributing to the docs
========================

1  -For detailed explanation go to:

https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

2 - if you are on for windows, install make

http://www.mingw.org/

Add ``C:\MinGW\bin`` in user PATH variable


3 - Get the ReadTheDocs theme

.. code-block:: python

        pip install sphinx_rtd_theme


4 - Clone the git project on your computer

https://help.github.com/en/articles/cloning-a-repository

The repository

https://drf-gitlab.cea.fr/bboyer/matis

5 - Go to docs and edit what you need. The documentation uses rst file syntax.

http://docutils.sourceforge.net/docs/ref/rst/directives.html

http://rest-sphinx-memo.readthedocs.io/en/latest/ReST.html


6 - To create html

``MATIS\docs> C:\MinGW\bin\make html``

or

```MATIS\docs> C:\MinGW\bin\mingw32-make.exe html``

6b - To create pdf

Get latex, if you have Miktek you need Perl

http://strawberryperl.com/

Check the PATH
If not done automatically, add ``C:\Strawberry\perl\bin``

then

``MATIS\docs> C:\MinGW\bin\make latexpdf``