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

[CT-2257] Reimplement automated documentation generation for CLI #7106

Closed
Tracked by #6548
stu-k opened this issue Mar 2, 2023 · 2 comments
Closed
Tracked by #6548

[CT-2257] Reimplement automated documentation generation for CLI #7106

stu-k opened this issue Mar 2, 2023 · 2 comments
Labels
python_api Issues related to dbtRunner Python entry point user docs [docs.getdbt.com] Needs better documentation

Comments

@stu-k
Copy link
Contributor

stu-k commented Mar 2, 2023

Details

In #7089, the workflow for auto generating documentation for the new CLI was removed. It actively hindered development and created frustrating merge conflicts. This should instead be coupled with the release workflow to make a commit on main with the updated docs.
@github-actions github-actions bot changed the title Reimplement automated documentation generation for CLI [CT-2257] Reimplement automated documentation generation for CLI Mar 2, 2023
@jtcohen6
Copy link
Contributor

jtcohen6 commented Mar 2, 2023

@stu-k I'm going to add to this tracking issue:

Does it feel like the same or separate work from the issue we opened yesterday?

@jtcohen6 jtcohen6 mentioned this issue Mar 2, 2023
Closed
@jtcohen6 jtcohen6 added user docs [docs.getdbt.com] Needs better documentation python_api Issues related to dbtRunner Python entry point internal_tooling labels Mar 3, 2023
@MichelleArk
Copy link
Contributor

created frustrating merge conflicts

Specifically around the environment.pickle file. If it's not necessary for sphinx, we should avoid checking it in and/or add .gitignore it.

@jtcohen6 jtcohen6 closed this as not planned Won't fix, can't repro, duplicate, stale Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
python_api Issues related to dbtRunner Python entry point user docs [docs.getdbt.com] Needs better documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@MichelleArk @jtcohen6 @stu-k