FaradayInstitution / BPX

BPX schema in pydantic and JSON schema format, and parsers
MIT License
25 stars 12 forks source link

Docs #43

Closed rtimms closed 11 months ago

rtimms commented 1 year ago

Add docs and update README. At the moment, docs must be built locally.

codecov[bot] commented 1 year ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (develop@804d758). Click here to learn what that means. Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #43 +/- ## ========================================== Coverage ? 96.49% ========================================== Files ? 9 Lines ? 257 Branches ? 0 ========================================== Hits ? 248 Misses ? 9 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter commented 11 months ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

:exclamation: No coverage uploaded for pull request base (develop@cd00a67). Click here to learn what that means.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #43 +/- ## ========================================== Coverage ? 97.07% ========================================== Files ? 9 Lines ? 308 Branches ? 0 ========================================== Hits ? 299 Misses ? 9 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rtimms commented 11 months ago

Need to update the URLs in the docs to point to the new repo