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

Add basic doc build CI job #80

Merged
merged 5 commits into from
Dec 13, 2023
Merged

Add basic doc build CI job #80

merged 5 commits into from
Dec 13, 2023

Conversation

NicolasHug
Copy link
Member

@NicolasHug NicolasHug commented Dec 13, 2023

This PR adds a basic doc build job - see Build Docs / build_docs below.

To see the build logs: just click on the Build Docs / build_docs and then on the "Build docs" part.

To download the generated docs (html files):

  • Go to "Summary"

image

  • Download zip file in the Artifacts section
    image

Still TODO, for other PRS: We should have a nice way to visualize the generated docs from the PR, without having to download and decompress the whole zip. Not too sure how to set that up right now, we'll probably have to upload those docs somewhere and make that link accessible.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Dec 13, 2023
@NicolasHug NicolasHug changed the title Add basic doc build CI jobs Add basic doc build CI job Dec 13, 2023
Copy link
Member

@rohan-varma rohan-varma left a comment

Choose a reason for hiding this comment

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

Amazing

@NicolasHug NicolasHug merged commit 640b37f into pytorch:main Dec 13, 2023
6 checks passed
@NicolasHug NicolasHug deleted the build_Docs_jbo branch December 13, 2023 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants