Create docs - Githubissues

kaitj commented 3 months ago

Wanted to open a PR for this before I forget what was done.

Created docs with pdoc, mostly covering API docstrings for niftyone. Left out niclips for now, but I'm not sure we want to include those.
Given its a single page (aside from the API), thinking we mostly link externally to relevant files in the repo. Tried to add a few things like FAQ, getting started etc., but open to moving things around.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.82%. Comparing base (4aabd84) to head (b8d97f0). Report is 38 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #15 +/- ## ======================================= Coverage 99.82% 99.82% ======================================= Files 16 16 Lines 578 578 ======================================= Hits 577 577 Misses 1 1 ```

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

kaitj commented 4 weeks ago

Closing this PR - I am reworking this in a new branch using mdbooks to keep everything in one format.

childmindresearch / niftyone

Create docs #15

Codecov Report