项目文件夹

文件
Da Zheng b1628f2398 [Tutorial] Distributed node classification. (#2969)
* 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>
2021-06-04 21:50:16 +08:00

37 行
682 B
Markdown

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.