ZoomQuiet avatar ZoomQuiet committed 8f24717

+ 0.5H rST 一节

Comments (0)

Files changed (3)

 import re
 import sphinx
 
-extensions = ['sphinx.ext.autodoc', 
+extensions = [
+    'sphinx.ext.autodoc', 
     'sphinx.ext.doctest', 
     'sphinx.ext.todo',
     'sphinx.ext.autosummary', 
-    #'sphinx.ext.extlinks'
+    'sphinx.ext.extlinks'
     ]
 
 master_doc = 'contents'
       而且不同的操作系统也有不同的路径指引要求,
       Sphnix 使用相对于 term:`资源目录` 的:dfn:`document names` 来统一这些问题,
       后綴可忽略,路径使用正斜线分隔,例如:
+      
         - ``index``
         - ``library/zipfile``
         - ``reference/datamodel/types``
+      
       注意: 不能前导正斜线!
 
    domain
 reStructuredText 入门
 =======================
 
-This section is a brief introduction to reStructuredText (reST) concepts and
-syntax, intended to provide authors with enough information to author documents
-productively.  Since reST was designed to be a simple, unobtrusive markup
-language, this will not take too long.
+本节简要介绍了 新结构化文本 ~ reStructuredText的 (reST)的概念和语法,
+旨在提供足够的信息来帮助作者高效起草文件.
+由于 reST 被设计成一个简单的,不显眼的标记语言,
+所以,这不会花太长时间.
 
 .. seealso::
 
-   The authoritative `reStructuredText User Documentation
-   <http://docutils.sourceforge.net/rst.html>`_.  The "ref" links in this
-   document link to the description of the individual constructs in the reST
-   reference.
+   权威 `新结构化文本用户文档 <http://docutils.sourceforge.net/rst.html>`_
+   在文章的 "ref" 链接中,有reST 各种结构的描述可供参考.
 
 
-Paragraphs
-----------
+段落 Paragraphs
+------------------------------
 
-The paragraph (:duref:`ref <paragraphs>`) is the most basic block in a reST
-document.  Paragraphs are simply chunks of text separated by one or more blank
-lines.  As in Python, indentation is significant in reST, so all lines of the
-same paragraph must be left-aligned to the same level of indentation.
 
+段落( :duref:`参考 <paragraphs>` )是 reST 文章中最常见的文本块.
+段落是由一个或多个空白分隔的文本块.
+同Python中的约定,在 reST 中使用缩进来标识,
+因此, 所有同级段落,必须左对齐,使用同级缩进.
 
 .. _inlinemarkup:
 
-Inline markup
--------------
+行内标记 Inline markup
+--------------------------
 
-The standard reST inline markup is quite simple: use
+标准的reST 行内标记很简单:
 
-* one asterisk: ``*text*`` for emphasis (italics),
-* two asterisks: ``**text**`` for strong emphasis (boldface), and
-* backquotes: ````text```` for code samples.
+* 单星号: ``*文本*`` 得 *强调* (斜体 :sup:`对中文一般效果不好`) ,
+* 双星号: ``**文本**`` 得 **加重** (加黑),
+* 反引号: ````文本```` 得 代码引用.
 
 If asterisks or backquotes appear in running text and could be confused with
 inline markup delimiters, they have to be escaped with a backslash.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.