-
Notifications
You must be signed in to change notification settings - Fork 103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add API references (frontend + backend) to documentation #2765
Conversation
…ocumentation + change GH actions
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #2765 +/- ##
========================================
Coverage 68.56% 68.56%
========================================
Files 86 86
Lines 7435 7435
========================================
Hits 5098 5098
Misses 2337 2337
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Add api references for both frontend and backend (also includes Utils-Flask-SQLAlchemy and Utils-Flask-SQLAlchemy-Geo). Change of the sphinx Github action. --------- Co-authored-by: TheoLechemia <[email protected]>
Add api references for both frontend and backend (also includes Utils-Flask-SQLAlchemy and Utils-Flask-SQLAlchemy-Geo). Change of the sphinx Github action. --------- Co-authored-by: TheoLechemia <[email protected]>
Une bonne pratique est d'ajouter la documentation se trouvant dans les
docstring
(en python) et dans laJSDoc
(javascript).Liste des modifications :
sphinx-autoapi
(https://sphinx-autoapi.readthedocs.io/en/latest/index.html)requirements
recompilécompodoc
(https://compodoc.app/)