提交 57abfe11 编写于 作者: Y yuyang18

Complete quick_start

上级 d3b795dd
[submodule "paddle"] [submodule "paddle"]
path = paddle path = paddle
url = https://github.com/PaddlePaddle/Paddle.git url = https://github.com/PaddlePaddle/Paddle.git
[submodule "book"]
path = book
url = https://github.com/PaddlePaddle/book.git
Subproject commit f4b5cc835ef77e55cfc001d51f8f77565475dc45
...@@ -15,6 +15,8 @@ ...@@ -15,6 +15,8 @@
import sys import sys
import os import os
import shlex import shlex
from recommonmark.parser import CommonMarkParser
from recommonmark.transform import AutoStructify
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
...@@ -33,6 +35,8 @@ extensions = [ ...@@ -33,6 +35,8 @@ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.todo',
'sphinx_markdown_tables',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
...@@ -40,8 +44,11 @@ templates_path = ['_templates'] ...@@ -40,8 +44,11 @@ templates_path = ['_templates']
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md'] source_parsers = {
source_suffix = '.rst' '.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' #source_encoding = 'utf-8-sig'
...@@ -112,7 +119,7 @@ todo_include_todos = False ...@@ -112,7 +119,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'classic' html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
...@@ -286,3 +293,12 @@ texinfo_documents = [ ...@@ -286,3 +293,12 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
def setup(app):
app.add_config_value('recommonmark_config', {
'auto_toc_tree_section': 'Contents',
'enable_inline_math': True,
'enable_eval_rst': True,
'enable_math': True
}, True)
app.add_transform(AutoStructify)
...@@ -3,15 +3,18 @@ ...@@ -3,15 +3,18 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to PaddlePaddle Fluid's documentation! ##############
============================================== 欢迎来到 Fluid
##############
Contents: .. todo::
内容简介,导引
.. toctree::
:maxdepth: 2
.. toctree::
:maxdepth: 1
quick_start/index.rst
Indices and tables Indices and tables
================== ==================
......
../../../../book/01.fit_a_line/image/predictions.png
\ No newline at end of file
../../../../book/01.fit_a_line/image/ranges.png
\ No newline at end of file
../../../../book/01.fit_a_line/image/train_and_test.png
\ No newline at end of file
../../../book/01.fit_a_line/README.cn.md
\ No newline at end of file
########### ########
新手入门 新手入门
########### ########
.. todo::
新手入门的导引文字,需要完善。
.. toctree::
:maxdepth: 2
install/index.rst
quick_start.rst
theoretical_background.rst
\ No newline at end of file
../../../paddle/doc/fluid/build_and_install/build_from_source_cn.rst
\ No newline at end of file
../../../paddle/doc/fluid/build_and_install/docker_install_cn.rst
\ No newline at end of file
../../../paddle/doc/fluid/build_and_install/index_cn.rst
\ No newline at end of file
../../../paddle/doc/fluid/build_and_install/paddleci.png
\ No newline at end of file
../../../paddle/doc/fluid/build_and_install/pip_install_cn.rst
\ No newline at end of file
########
快速入门
########
.. todo::
概述
.. toctree::
:maxdepth: 2
fit_a_line/index.md
recognize_digits/index.md
\ No newline at end of file
../../../../book/02.recognize_digits/image/cnn.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/cnn_train_log.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/conv_layer.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/infer_3.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/max_pooling.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/mlp.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/mlp_train_log.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/mnist_example_image.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/softmax_regression.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/softmax_train_log.png
\ No newline at end of file
../../../../book/02.recognize_digits/image/train_and_test.png
\ No newline at end of file
../../../book/02.recognize_digits/README.cn.md
\ No newline at end of file
########
理论知识
########
.. todo::
完善这个页面
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册