OSSForks/pytorch
1
0
Fork 0
mirror of https://github.com/zebrajr/pytorch.git synced 2025-12-07 12:21:27 +01:00
Code Issues Actions 38 Packages Projects Releases Wiki Activity
39df901b2a
pytorch/functorch/docs
History
Svetlana Karslioglu cd7bc60e11 Migrate to new theme (#149331) 
- Migrate pytorch docs, cpp docs and functorch docs to the pytorch_sphinx_theme2
- Migrate index.rst to markdown and restructure to use high-level horizontal bar sections Python API, Developer Notes
- Added python-api.md which becomes the main container for the API docs. This file will be used to add all api references in the toctree. It would be great to have lint for this file: https://github.com/pytorch/pytorch/issues/150718
- Enabled mermaid sphinx extension and opengraph sphinx extension

Pull Request resolved: https://github.com/pytorch/pytorch/pull/149331
Approved by: https://github.com/malfet, https://github.com/atalman, https://github.com/albanD
2025-04-16 21:35:19 +00:00
..
source Migrate to new theme (#149331) 2025-04-16 21:35:19 +00:00
.gitignore
Makefile
README.md

README.md

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.

  1. Build the docs
  2. Save the build/html folder somewhere
  3. Checkout the branch gh-pages.
  4. Delete the contents of the branch and replace it with the build/html folder. index.html should be at the root.
  5. Commit the changes and push the changes to the gh-pages branch.