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 for CLI and API #83

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Auto-documentation for CLI and API #83

wants to merge 8 commits into from

Conversation

zgoldberg22
Copy link
Collaborator

Addresses issue #76

Generates documentation for the Aerie-CLI API using sphinx-apidocs and documentation for Aerie-CLI using typer-cli.

@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 14, 2023 20:20 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 14:58 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow September 15, 2023 15:34 — with GitHub Actions Inactive
cartermak
cartermak reviewed Oct 17, 2023
View reviewed changes
cli_docs/app.md Outdated
**Usage**:

```console
$ aerie-cli app [OPTIONS] COMMAND [ARGS]...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to update the configuration to make these docs show all these commands at the root, i.e., aerie-cli [COMMAND] instead of aerie-cli app [COMMAND]?

@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@zgoldberg22 zgoldberg22 temporarily deployed to integration-test-workflow October 25, 2023 15:06 — with GitHub Actions Inactive
@cartermak cartermak added this to the v3 milestone Jan 29, 2024
@zgoldberg22 zgoldberg22 marked this pull request as ready for review May 8, 2024 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cartermak cartermak cartermak left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3
Development

Successfully merging this pull request may close these issues.
2 participants
@zgoldberg22 @cartermak