Skip to content

Commit 57abfe1

Browse files
committed
Complete quick_start
1 parent d3b795d commit 57abfe1

29 files changed

Lines changed: 88 additions & 11 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.env

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
[submodule "paddle"]
22
path = paddle
33
url = https://github.com/PaddlePaddle/Paddle.git
4+
[submodule "book"]
5+
path = book
6+
url = https://github.com/PaddlePaddle/book.git

book

Submodule book added at f4b5cc8

source/conf.py

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
import sys
1616
import os
1717
import shlex
18+
from recommonmark.parser import CommonMarkParser
19+
from recommonmark.transform import AutoStructify
1820

1921
# If extensions (or modules to document with autodoc) are in another directory,
2022
# add these directories to sys.path here. If the directory is relative to the
@@ -33,15 +35,20 @@
3335
'sphinx.ext.autodoc',
3436
'sphinx.ext.mathjax',
3537
'sphinx.ext.viewcode',
38+
'sphinx.ext.todo',
39+
'sphinx_markdown_tables',
3640
]
3741

3842
# Add any paths that contain templates here, relative to this directory.
3943
templates_path = ['_templates']
4044

4145
# The suffix(es) of source filenames.
4246
# You can specify multiple suffix as a list of string:
43-
# source_suffix = ['.rst', '.md']
44-
source_suffix = '.rst'
47+
source_parsers = {
48+
'.md': CommonMarkParser,
49+
}
50+
51+
source_suffix = ['.rst', '.md']
4552

4653
# The encoding of source files.
4754
#source_encoding = 'utf-8-sig'
@@ -112,7 +119,7 @@
112119

113120
# The theme to use for HTML and HTML Help pages. See the documentation for
114121
# a list of builtin themes.
115-
html_theme = 'classic'
122+
html_theme = 'sphinx_rtd_theme'
116123

117124
# Theme options are theme-specific and customize the look and feel of a theme
118125
# further. For a list of options available for each theme, see the
@@ -286,3 +293,12 @@
286293

287294
# If true, do not generate a @detailmenu in the "Top" node's menu.
288295
#texinfo_no_detailmenu = False
296+
297+
def setup(app):
298+
app.add_config_value('recommonmark_config', {
299+
'auto_toc_tree_section': 'Contents',
300+
'enable_inline_math': True,
301+
'enable_eval_rst': True,
302+
'enable_math': True
303+
}, True)
304+
app.add_transform(AutoStructify)

source/index.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,19 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to PaddlePaddle Fluid's documentation!
7-
==============================================
6+
##############
7+
欢迎来到 Fluid
8+
##############
89

9-
Contents:
10-
11-
.. toctree::
12-
:maxdepth: 2
10+
.. todo::
11+
内容简介,导引
1312

1413

14+
.. toctree::
15+
:maxdepth: 1
1516

17+
quick_start/index.rst
18+
1619
Indices and tables
1720
==================
1821

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../book/01.fit_a_line/image/predictions.png
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../book/01.fit_a_line/image/ranges.png
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../book/01.fit_a_line/image/train_and_test.png
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../book/01.fit_a_line/README.cn.md

source/quick_start/index.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1-
###########
1+
########
22
新手入门
3-
###########
3+
########
4+
5+
.. todo::
6+
7+
新手入门的导引文字,需要完善。
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
install/index.rst
13+
quick_start.rst
14+
theoretical_background.rst

0 commit comments

Comments
 (0)