Skip to content

Commit 0aa742d

Browse files
committed
Merge branch 'release/0.1.2'
2 parents bcb7ce8 + 872e9fd commit 0aa742d

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

README.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Fluid Documentation Skeleton
2+
3+
## Build
4+
5+
To build documentation, you need have a linux machine and have python2, virtualenv, gmake installed.
6+
7+
### Preparation
8+
9+
You need to create a `virtualenv` instead of polute the global python library path
10+
11+
```bash
12+
virtualenv .env
13+
```
14+
15+
You can enter virtualenv by
16+
17+
```bash
18+
source .env/bin/activate
19+
```
20+
21+
You can exit virtualenv by
22+
23+
```bash
24+
deactivate
25+
```
26+
27+
### Install dependencies
28+
29+
```bash
30+
# enter virtualenv
31+
source .env/bin/activate
32+
# install dependencies
33+
pip install -r requirements.txt
34+
```
35+
36+
### Make HTML
37+
38+
```bash
39+
# make clean # make clean to regenerate toctree. Just `make html` may have a cache.
40+
make html
41+
```
42+
and the html files will be generated to `build/html`. You can open `build/html/index.html` with your browser to see the documentation.
43+
44+
## Edit
45+
46+
### Edit documentation
47+
48+
It is suggested to use `reStructuredText` because it is the only official markup language supportted by our documentation generating system, sphinx. `markdown` can also be used. However, since the `markdown` has so many dialects, there is no guarantee that the `markdown` source file can be rendered well.
49+
50+
The `reStructuredText` cheatsheet is [here](http://docutils.sourceforge.net/docs/user/rst/quickref.html).
51+
52+
53+
### Edit structure
54+
55+
The `sphinx` (our documentation generating system) uses `toctree` to organize documentation. `toctree` means `table of content tree`.
56+
57+
Please see the [sphinx documentation](http://www.sphinx-doc.org/en/master/), especially [`toctree` directives](http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)

source/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import shlex
1818
from recommonmark.parser import CommonMarkParser
1919
from recommonmark.transform import AutoStructify
20+
import paddle.fluid
2021

2122
# If extensions (or modules to document with autodoc) are in another directory,
2223
# add these directories to sys.path here. If the directory is relative to the

0 commit comments

Comments
 (0)