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-1252] [Feature] Create GHA to autogenerate documentation using Sphinx #5942

Closed
leahwicz opened this issue Sep 27, 2022 · 0 comments · Fixed by #6187
Closed

[CT-1252] [Feature] Create GHA to autogenerate documentation using Sphinx #5942

leahwicz opened this issue Sep 27, 2022 · 0 comments · Fixed by #6187
Assignees

Comments

@leahwicz
Copy link
Contributor

leahwicz commented Sep 27, 2022

Describe the feature

This is the next step after this ticket #5528

After we have Sphinx configured and able to generate documentation for our future APIs, we want to be able to automate this by using GitHub Actions.

Exit criteria: a GitHub Action that-

  • you can trigger manually or on a push to main or release branches
  • the documentation is uploaded as an artifact of the run

Future work out of scope for this:

  • Uploading docs to during to our GitHub Release automatically
  • Leveraging these docs in the docs website
@leahwicz leahwicz added enhancement New feature or request triage labels Sep 27, 2022
@github-actions github-actions bot changed the title [Feature] Create GHA to autogenerate documentation using Sphinx [CT-1252] [Feature] Create GHA to autogenerate documentation using Sphinx Sep 27, 2022
@leahwicz leahwicz added Team:Execution and removed enhancement New feature or request triage labels Sep 27, 2022
@stu-k stu-k reopened this Nov 8, 2022
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.

2 participants