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.

Sign up for GitHub

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

Jump to bottom

Auto-documentation #76

Open
cartermak opened this issue Sep 6, 2023 · 1 comment
Open

Auto-documentation #76

cartermak opened this issue Sep 6, 2023 · 1 comment
Assignees
@zgoldberg22
Labels
documentation Improvements or additions to documentation enhancement New/improved features and capabilities
Milestone
v3

Comments

@cartermak
Copy link
Member

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 cartermak added documentation Improvements or additions to documentation enhancement New/improved features and capabilities labels Sep 6, 2023
@cartermak cartermak mentioned this issue Sep 7, 2023
Closed
4 tasks
@cartermak
Copy link
Member Author

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).

@zgoldberg22 zgoldberg22 mentioned this issue Sep 14, 2023
Open
@cartermak cartermak added this to the v3 milestone Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zgoldberg22 zgoldberg22

Labels
documentation Improvements or additions to documentation enhancement New/improved features and capabilities
Projects
None yet
Milestone
v3
Development

No branches or pull requests
2 participants
@cartermak @zgoldberg22