Add doc build #216
Merged
Add doc build #216
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
meta-cla
bot
added
the
CLA Signed
|
Thanks @svekars ! is it possible for me to preview the docs or does it have to be pushed first? |
|
@allenwang28 I see somehow it ran once: https://github.com/meta-pytorch/forge/actions/runs/17960991477/job/51084022457?pr=216 - let me fix the errors there first. |
|
ah so the ./scripts/install.sh will probably not work in CI right now - it's pretty hyper-focused on my Dev GPU setup. I am in parallel trying to get this handled in #221 |
svekars
force-pushed
the
add-doc-build-job
branch
from
fdf3d3c to
4036542
Compare
|
ok, I actually was able to build it. You can download the artifact here and open on your local machine to preview: https://github.com/meta-pytorch/forge/actions/runs/17963103609/job/51090348345?pr=216#step:11:24 |
allenwang28
approved these changes
Sep 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new documentation build workflow, Sphinx configuration, placeholder sections, and API documentation structure. The changes automate documentation builds and previews, standardize documentation dependencies, and provide detailed module-level API references for all major components.
.github/workflows/docs.yml) to automate building, previewing, and deploying documentation for pushes, pull requests, and manual triggers. This includes multi-version Python support, artifact uploads, and GitHub Pages deployment.docs/Makefile,docs/make.bat, anddocs/source/conf.pydocs/requirements.txtspecifying all documentation dependencies, including Sphinx, PyTorch theme, and various extensions for enhanced documentation features.