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

Update documentation after FastAPI migration #140

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Conversation

LuiggiTenorioK
Copy link
Member

@LuiggiTenorioK LuiggiTenorioK commented Nov 12, 2024

We need to update our documentation to:

  • Include a guide to how to access the Swagger UI/OpenAPI generated by FastAPI
  • Explain how the auth module works (from GitLab wiki)
  • Explain the performance metrics (from GitLab wiki)
  • Update old pages with new options

Copy link
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments, but no blockers (feel free to ignore/update them as you see fit) 👍

docs/source/guides/auth/index.rst Show resolved Hide resolved
docs/source/guides/auth/index.rst Outdated Show resolved Hide resolved
docs/source/guides/auth/index.rst Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.28%. Comparing base (2579e8b) to head (10e2b51).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #140   +/-   ##
=======================================
  Coverage   70.28%   70.28%           
=======================================
  Files          82       82           
  Lines        7932     7932           
=======================================
  Hits         5575     5575           
  Misses       2357     2357           
Flag Coverage Δ
fast-tests 70.28% <ø> (ø)

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.

@LuiggiTenorioK
Copy link
Member Author

Ok, now I think that everything is sorted. Also, the RTD webhook already is integrated into this repo.

Here is the preview: https://autosubmit-api.readthedocs.io/en/updt-docs-202411/index.html

@LuiggiTenorioK LuiggiTenorioK self-assigned this Nov 13, 2024
@LuiggiTenorioK LuiggiTenorioK merged commit 86cb47d into main Nov 21, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants