Skip to content

Commit 037526f

Browse files
committed
添加文档如何使用章节
1 parent 2a135d1 commit 037526f

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.. include:: README.rst
22

3+
.. include:: meta.rst
34

45
.. toctree::
56
:glob:

meta.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
如何编译 reST 文档
2+
------------------
3+
4+
reST 文档的编译依赖 make 和 sphinx,安装完依赖后在文档的根目录执行
5+
`make html` 构建 HTML 文档,如无错误即可在 `_build/html` 目录中生成对应的 HTML 文件,
6+
可以在浏览器中直接打开 `_build/html/index.html` 预览生成的 HTML。
7+
8+
本文档托管在 ReadTheDocs,文档合并之主分支后将会自动构建,预览请访问 `RTFD <http://z42.readthedocs.org/zh/latest/>`_ 。

0 commit comments

Comments
 (0)