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

Doc/add sphinx doc #83

Closed raphaelventura closed 2 years ago

raphaelventura commented 2 years ago

This PR adds the ability to build Read the docs-style documentation using sphinx.

Code docstrings were updated accordingly and notes were added inside the README and data_science_workflow files.

I did not add a git hook for automatic generation yet since the build/ folder weighs as much as 15MB (!), and I don't think it should be pushed to github. Maybe this could be done as gh pages outside of this repo. What do you think @vviers ?