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

docs: add sphinx documentation and add missing documentation #18

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

d4l3k
Copy link
Member

@d4l3k d4l3k commented Nov 27, 2024

This adds sphinx documentation following the setup from https://github.com/pytorch/torchx.

This will build it in Github Actions CI and then deploy it.

Notably, this only builds the latest version of the documentation and not historical versions.

Test plan:

cd docs
pip install -r requirements.txt
make livehtml
make html

CI

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Nov 27, 2024
@d4l3k
Copy link
Member Author

d4l3k commented Nov 27, 2024

CI passing -- landing to main to test deploy

@d4l3k d4l3k merged commit 4ad6f1b into main Nov 27, 2024
3 of 5 checks passed
@d4l3k d4l3k deleted the d4l3k/docs branch November 27, 2024 01:28
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