-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
# sphinxhowto | ||
|
||
本文介绍当前最流行的软件工程文档书写工具 Sphinx。 | ||
本文介绍当前最流行的软件工程文档书写工具 Sphinx。 | ||
|
||
Sphinx本意狮身人面像,在这里它是一个编写文档的工具,可以令人轻松的撰写出清晰且优美的文档。 它基于reStructuredText(reST)语言,reST语言是一种轻量级的文本标记语言,为Python中Docutils项目的一部分。 因此文档的源文件以.rst为后缀,Sphnix对reST语言进行了扩展,它负责把.rst源文件转化成易于阅读的html,pdf,epub,man 等目标格式。它一开始为著名的Python语言开发者所采用,后来被越来越多的开发者们用于撰写软件文档, Linux内核开发者们也把目光投向了它。 | ||
Sphinx本意狮身人面像,在这里它是一个编写文档的工具,可以令人轻松的撰写出清晰且优美的文档。 它基于reStructuredText(reST)语言,reST语言是一种轻量级的文本标记语言,为Python中Docutils项目的一部分。 因此文档的源文件以.rst为后缀,Sphnix对reST语言进行了扩展,它负责把.rst源文件转化成易于阅读的html,pdf,epub,man 等目标格式。它一开始为著名的Python语言开发者所采用,后来被越来越多的开发者们用于撰写软件文档, Linux内核开发者们也把目光投向了它。 | ||
|
||
reST语言相对于过往的DocBook所采用的XML标记语言要简单和明了,就像在很多时候json格式渐渐取代了xml一样。这也是 Sphinx日渐流行起来的原因。 | ||
reST语言相对于过往的DocBook所采用的XML标记语言要简单和明了,就像在很多时候json格式渐渐取代了xml一样。这也是 Sphinx日渐流行起来的原因。 | ||
|
||
通过点击 [在readthedocs中显示当前文档](https://sphinxdocs.readthedocs.io/en/latest/index.html) 可以浏览该文档的最新版本。 | ||
通过点击 [在readthedocs中显示当前文档](https://sphinxdocs.readthedocs.io/en/latest/index.html) 可以浏览该文档的最新版本。 |