Add sphinx documentation

signaux-faibles / predictsignauxfaibles

Dépôt du code python permettant la production de liste de prédiction Signaux Faibles.

MIT License

6 stars 1 forks source link

Closed raphaelventura closed 2 years ago

raphaelventura commented 2 years ago

An HTML documentation could easily be generated using sphinx-napoleon.

[x] Format docstrings and function signatures in compliance with napoleon Google style.
[x] Update repository config
[ ] Add a CI job that builds and publishes doc and runs on a regular basis (every time a branch is merged for instance)