Write documentation

Principle

• The documentation of I-Simpa is located in the folder I-Simpa/Docs/ for the text and in the I-Simpa/Docs/images/ for the image
• The documentation is written with the reStructuredText format
• The documentation is built using Sphinx and hosted by Read the Docs (online documentation)
• The online documentation is automatically built and updated once the modification are validated: https://i-simpa-wiki.readthedocs.io/fr/latest/

Contribute to the documentation

• Login to your GitHub account.
• For minor changes, you can directly modify the documentation files in the repository and commit the changes
• For major changes, we recommend you to fork the I-Simpa project and to modify the documentation files
• Once the pull is requested, a Reviewer will valid the contributions and update the main repository
• If accepted, your contribution will be displayed in the I-Simpa software (remember that contributors should accept and sign the License Agreement for Contributors at the following page: https://i-simpa.univ-gustave-eiffel.fr/community/contribute/contribute-to-the-code/