dmlc--dgl
b1628f2398
* add init version. * fix build. * fix format. * fix. * fix. * fix format. * update README. * avoid running CI on distributed training tutorials. * Update tutorials/dist/1_node_classification.py Co-authored-by: xiang song(charlie.song) <classicxsong@gmail.com> * fix. Co-authored-by: xiang song(charlie.song) <classicxsong@gmail.com>
682 B
682 B
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:
- build tutorials that uses MXNet as backend
- 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.