Skip to content

Commit a353a2a

Browse files
committed
Added instructions for generating Python API documentation
1 parent 4c670eb commit a353a2a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,20 @@ If you do not have CUDA installed, you can still use the taco cli to generate CU
7979

8080
The generated CUDA code will require compute capability 6.1 or higher to run.
8181

82+
## Generating documentation
83+
To generate documentation for the Python API:
84+
85+
cd <taco-directory>/python_bindings
86+
make html
87+
88+
Before generating the documentation, you must have first built the Python API
89+
(by following the [instructions above](#building-python-api)) as well as
90+
installed the following dependencies:
91+
92+
pip install sphinx
93+
pip install numpydoc
94+
pip install sphinx-rtd-theme
95+
8296
## Running tests
8397
To run all tests:
8498

0 commit comments

Comments
 (0)