Skip to content
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

Merged
merged 13 commits into from
Nov 21, 2023

Conversation

jacquesfize
Copy link
Contributor

Une bonne pratique est d'ajouter la documentation se trouvant dans les docstring (en python) et dans la JSDoc (javascript).

Liste des modifications :

  • Auto-documentation (juste la génération des rst) du backend avec sphinx-autoapi (https://sphinx-autoapi.readthedocs.io/en/latest/index.html)
    • requirements recompilé
  • Génération de la documentation du frontend avec compodoc (https://compodoc.app/)
  • Modification de la Github Action qui build la documentation
    • Le push sur la doc officiel est désactivé le temps de faire les tests
    • Le build passe pour le moment

@jacquesfize jacquesfize changed the title Add API (frontend + backend) to documentation Add API references (frontend + backend) to documentation Oct 25, 2023
@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f835f5c) 68.56% compared to head (95fd353) 68.56%.

❗ Current head 95fd353 differs from pull request most recent head 4baac08. Consider uploading reports for the commit 4baac08 to get more accurate results

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           
Flag Coverage Δ
pytest 68.56% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jacquesfize jacquesfize marked this pull request as ready for review October 27, 2023 09:50
@camillemonchicourt camillemonchicourt added this to the 2.14 milestone Nov 13, 2023
@jacquesfize jacquesfize merged commit be8575a into develop Nov 21, 2023
8 checks passed
@jacquesfize jacquesfize deleted the update-doc branch November 21, 2023 13:15
jacquesfize added a commit that referenced this pull request Jan 9, 2024
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]>
jacquesfize added a commit to jbrieuclp/GeoNature that referenced this pull request Jan 9, 2024
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants