| Stella Laurenzo | 0ff6e5f | 2021-09-25 20:08:20 -0700 | [diff] [blame] | 1 | # Python API Docs |
| 2 | |
| 3 | Documentation for the Python API is built with Sphinx under this directory. |
| 4 | When new versions are released, the documentation is generated and published |
| 5 | to the website. |
| 6 | |
| 7 | ## Building Docs |
| 8 | |
| 9 | ### Install IREE binaries |
| 10 | |
| 11 | Either install python packages or, from the build directory: |
| 12 | |
| 13 | ```shell |
| 14 | export PYTHONPATH=$PWD/bindings/python:$PWD/compiler-api/python_package |
| 15 | ``` |
| 16 | |
| 17 | ### Install dependencies |
| 18 | |
| 19 | ```shell |
| 20 | python -m pip install -r requirements.txt |
| 21 | ``` |
| 22 | |
| 23 | |
| 24 | ### Build docs |
| 25 | |
| 26 | ```shell |
| 27 | sphinx-build -b html . _build |
| 28 | ``` |
