Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
79051ed
commit a40e490
Showing
2 changed files
with
14 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
How to build the docs? | ||
====================== | ||
|
||
Building the docs requires installing the dependencies listed in `requirements.txt`. | ||
|
||
The building process involves conversion of Jupyter notebooks to `rst` files. To facilitate this you need to set `NB_KERNEL` environment variable to the desired python kernel (e.g. `export NB_KERNEL="python3"`). To get a list of python kernels available, run `jupyter kernelspec list`. | ||
|
||
After you're set, from the `doc` directory run `make notebooks html` to convert all notebooks, build all gallery examples and the documentation iteslf. The designated output folder is `_build/html`. | ||
|
||
Run `make clean` to delete a built documentation. |