search

Garden-AI / garden

https://garden-ai.readthedocs.io
MIT License
16 stars 4 forks source link

Create reference docs for garden-ai CLI #456

Closed hholb closed 2 months ago

hholb commented 2 months ago

Resolves #450

Overview

Create reference documentation for the garden-ai CLI.

Discussion

Docs were generated using typer's doc generation utility.

The version of typer we are currently using, 0.7.0, doesn't support this feature. I upgraded to the latest version, 0.12.*, to generate these docs. I ran the test suite using the latest version before reverting back to 0.7.0. One test fails, but it looks like minor change would fix it. Should we consider upgrading to the latest version of typer?

Testing

Tested using poetry run mkdocs serve and it looks good.

Documentation

This adds a new page for the CLI Reference, and adds an entry to mkdocs.yml.

📚 Documentation preview 📚: https://garden-ai--456.org.readthedocs.build/en/456/

codecov-commenter commented 2 months ago

Codecov Report

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

Project coverage is 75.41%. Comparing base (a9b1f92) to head (c787116).

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #456 +/- ## ======================================= Coverage 75.41% 75.41% ======================================= Files 50 50 Lines 3197 3197 ======================================= Hits 2411 2411 Misses 786 786 ```

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