mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 12:20:52 +01:00
bb6b24c622
Saw some connection error to pip in docs jobs today, so let's dockerize it: * https://github.com/pytorch/pytorch/actions/runs/4877612277/jobs/8702572072 * https://github.com/pytorch/pytorch/actions/runs/4877612277/jobs/8702572072 Some additional fixes: * Moving the docs script from under `.circleci` to under `.ci` as they should be * Linter (as scripts under .ci are subjected to shellcheck) * Fix some minor Sphinx warnings in functorch docs ### Testing Docs previews look fine: * https://docs-preview.pytorch.org/100601/index.html * https://docs-preview.pytorch.org/100601/cppdocs/index.html * https://docs-preview.pytorch.org/100601/functorchdocs/index.html Pull Request resolved: https://github.com/pytorch/pytorch/pull/100601 Approved by: https://github.com/clee2000 |
||
|---|---|---|
| .. | ||
| source | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
functorch docs build
Build Locally
Install requirements:
pip install -r requirements.txt
One may also need to install pandoc. On Linux we can use: sudo apt-get install pandoc. Or using conda we can use: conda install -c conda-forge pandoc.
To run the docs build:
make html
Check out the output files in build/html.
Deploy
The functorch docs website does not updated automatically. We need to periodically regenerate it.
You need write permissions to functorch to do this. We use GitHub Pages to serve docs.
- Build the docs
- Save the build/html folder somewhere
- Checkout the branch
gh-pages. - Delete the contents of the branch and replace it with the build/html folder.
index.htmlshould be at the root. - Commit the changes and push the changes to the
gh-pagesbranch.