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

Improve docs #977

Merged
merged 1 commit into from
May 19, 2024
Merged

Improve docs #977

merged 1 commit into from
May 19, 2024

Conversation

jwag956
Copy link
Collaborator

@jwag956 jwag956 commented May 18, 2024

Made a sweep through all the docs and fixed/improved things:

  • added missing recoverY_codes API
  • added missing change_email signals
  • many openapi requests had a missing 'type: string' so didn't render
  • added sphinx extension autosectionlabel to make it easier to link
  • moved overview and search to top of doc pages (for some long pages like API - it was hard to find them at the bottom).

Made a sweep through all the docs and fixed/improved things:

- added missing recoverY_codes API
- added missing change_email signals
- many openapi requests had a missing 'type: string' so didn't render
- added sphinx extension autosectionlabel to make it easier to link
- moved overview and search to top of doc pages (for some long pages like API - it was hard to find them at the bottom).
Copy link

codecov bot commented May 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.44%. Comparing base (442faf3) to head (ff98e12).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #977   +/-   ##
=======================================
  Coverage   98.44%   98.44%           
=======================================
  Files          36       36           
  Lines        4625     4625           
=======================================
  Hits         4553     4553           
  Misses         72       72           

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

@jwag956 jwag956 merged commit 9616b52 into master May 19, 2024
19 checks passed
@jwag956 jwag956 deleted the docs12 branch May 19, 2024 00:18
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant