https://github.com/dmlc/dgl
Revision 411bef5498bc79641858ea15ee79b6085c855187 authored by Tomasz Patejko on 11 June 2021, 09:09:30 UTC, committed by GitHub on 11 June 2021, 09:09:30 UTC
1 parent 17d604b
Raw File
Tip revision: 411bef5498bc79641858ea15ee79b6085c855187 authored by Tomasz Patejko on 11 June 2021, 09:09:30 UTC
[CPU, Parallel] parallel_for with default grain size (#3004)
Tip revision: 411bef5
README.md
DGL document and tutorial folder
================================

Requirements
------------
* sphinx
* sphinx-gallery
* sphinx_rtd_theme
* Both pytorch and mxnet installed.

Build documents
---------------
First, clean up existing files:
```
./clean.sh
```

Then build:
```
make html
```

Note: due to the backend loading issue, it actually takes 2 rounds to build:
1. build tutorials that uses MXNet as backend
2. build tutorials that uses PyTorch as backend

Render locally
--------------
```
cd build/html
python3 -m http.server 8000
```

Add new folders
---------------
Add the path of the new folder in the two lists `examples_dirs` and `gallery_dirs` in docs/source/conf.py.
back to top