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.

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

[CT-902] CLI (Top level API) is automatically documented #5528

Closed
Tracked by #5527
iknox-fa opened this issue Jul 25, 2022 · 2 comments · Fixed by #6022
Closed
Tracked by #5527

[CT-902] CLI (Top level API) is automatically documented #5528

iknox-fa opened this issue Jul 25, 2022 · 2 comments · Fixed by #6022
Assignees

Comments

@iknox-fa
Copy link
Contributor

iknox-fa commented Jul 25, 2022

User Story:
As a user I would like to have accurate and easy to read documentation for how to use dbt-core as a library.

Acceptance Criteria:
An auto-documentation product (probably Sphinx) is set up and documents the top-level api. This runs as a GHA.

@github-actions github-actions bot changed the title CLI (Top level API) is automatically documented [CT-902] CLI (Top level API) is automatically documented Jul 25, 2022
@leahwicz
Copy link
Contributor

leahwicz commented Jul 29, 2022

Let's make sure we account for accurate help text for commands which is referenced in this issue:
#5319

@iknox-fa
Copy link
Contributor Author

FYI-- I think there's been some confusion vis-a-vis the documentation. This ticket is to generate sphinx docs as a reference, it doesn't refer to help text at all.

That said, after looking at #5319 we don't have to worry about it. The behavior described there is the default behavior for Click CLIs so we get that for "free"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants