search

NASA-AMMOS / aerie-cli

An unofficial CLI for interacting with Aerie planning software
MIT License
3 stars 4 forks source link

Auto-documentation #76

Open cartermak opened 1 year ago

cartermak commented 1 year ago

Investigate setting up an auto-documentation tool like Sphinx to document the full Aerie-CLI Python API.

Additionally, consider adding the sphinx-click plugin to focus on documentation of the CLI app (the Typer library is built on top of click), or using typer-cli to generate CLI docs.

cartermak commented 1 year ago

Also, share any recommendations based on the library/libraries you end up using for how we should document both the API in general and the CLI commands in particular (e.g., docstring styles).