Skip to content

Conversation

svekars
Copy link
Contributor

@svekars svekars commented Sep 30, 2025

This pull request updates documentation build system and structure for torchforge

  • updates to conf.py
  • improved deployment logic for versioned docs, update to in GitHub Actions
  • Added template_tutorial.py and config for sphinx-gallery

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Sep 30, 2025
@svekars svekars requested a review from allenwang28 October 3, 2025 16:31
@svekars svekars marked this pull request as ready for review October 3, 2025 16:31
@svekars svekars changed the title Add Sphinx gallery and basic API docs Add Sphinx gallery and fixes to the doc build Oct 3, 2025
"exclude-members": "__weakref__",
}

# Mock imports for dependencies that aren't available during doc building
Copy link
Contributor

Choose a reason for hiding this comment

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

just for my understanding, once we have wheels that work in CI then we can go ahead and remove all of this right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it might be problematic for a local installation that doesn't have all these deps more than the CI since we are installing all this. Also, just for API docs these import might not be necessarily needed. Since I'm only adding doc build changes and sphinx gallery in this PR, I will delete this part for now.

@svekars svekars merged commit cf2afd7 into main Oct 6, 2025
8 checks passed
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 Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants