1functorch docs build 2-------------------- 3 4## Build Locally 5 6Install requirements: 7``` 8pip install -r requirements.txt 9``` 10 11One may also need to install [pandoc](https://pandoc.org/installing.html). On Linux we can use: `sudo apt-get install pandoc`. Or using `conda` we can use: `conda install -c conda-forge pandoc`. 12 13To run the docs build: 14``` 15make html 16``` 17 18Check out the output files in `build/html`. 19 20## Deploy 21 22The functorch docs website does not updated automatically. We need to periodically regenerate it. 23 24You need write permissions to functorch to do this. We use GitHub Pages to serve docs. 25 261. Build the docs 272. Save the build/html folder somewhere 283. Checkout the branch `gh-pages`. 294. Delete the contents of the branch and replace it with the build/html folder. `index.html` should be at the root. 305. Commit the changes and push the changes to the `gh-pages` branch. 31