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

Documentation #208

Merged
merged 7 commits into from
Jan 9, 2025
Merged

Documentation #208

merged 7 commits into from
Jan 9, 2025

Conversation

AlecThomson
Copy link
Collaborator

This pirate got a little lost a sea - it's time for more documentation!

This PR sets up a Myst-based set of docs to be built on readthedocs.io. @tjgalvin will need to set up the build on that side, and then we'll need to update the REAME to point there properly.

I've left some TODOs, but I'll create some issues to track those too.

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.74%. Comparing base (36325dd) to head (952947c).
Report is 8 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #208   +/-   ##
=======================================
  Coverage   60.74%   60.74%           
=======================================
  Files          36       36           
  Lines        6233     6233           
=======================================
  Hits         3786     3786           
  Misses       2447     2447           

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

@AlecThomson AlecThomson merged commit 4297c3c into main Jan 9, 2025
1 of 2 checks passed
@AlecThomson AlecThomson deleted the docs branch January 9, 2025 06:24
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.

1 participant