README.md 682 Bytes
Newer Older
Minjie Wang's avatar
Minjie Wang committed
1
2
3
DGL document and tutorial folder
================================

4
5
6
7
Requirements
------------
* sphinx
* sphinx-gallery
Minjie Wang's avatar
Minjie Wang committed
8
* sphinx_rtd_theme
9
10
* Both pytorch and mxnet installed.

11
12
13
14
15
16
17
18
Build documents
---------------
First, clean up existing files:
```
./clean.sh
```

Then build:
Minjie Wang's avatar
Minjie Wang committed
19
20
21
22
```
make html
```

23
24
25
26
27
28
29
30
31
32
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
```
33
34
35
36

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