1. Zoom Quiet
  2. sphinx_zh

Commits

Zoom Quiet  committed acc8d7c

+ 0.5H reST 40%

  • Participants
  • Parent commits 8f24717
  • Branches doc-zh

Comments (0)

Files changed (1)

File rest.rst

View file
  • Ignore whitespace
 If asterisks or backquotes appear in running text and could be confused with
 inline markup delimiters, they have to be escaped with a backslash.
 
+如果有星号或反引号出现在引用的文本,
+就可能会弄乱内联标记分隔符,这时,可以用反斜杠来转义.
+
 Be aware of some restrictions of this markup:
+以下是知道这些标记的一些限制:
 
-* it may not be nested,
-* content may not start or end with whitespace: ``* text*`` is wrong,
-* it must be separated from surrounding text by non-word characters.  Use a
-  backslash escaped space to work around that: ``thisis\ *one*\ word``.
+* 不可叠用
+* 前后不能用空格: ``* text*`` 这样会出错,
+* 必须和周围文字用非单词隔离, 一般使用转义空白来完成: ``thisis\ *one*\ word`` 
 
 These restrictions may be lifted in future versions of the docutils.
+docutils未来版本中,可能取消这些限制.
 
 reST also allows for custom "interpreted text roles"', which signify that the
 enclosed text should be interpreted in a specific way.  Sphinx uses this to
 provide semantic markup and cross-referencing of identifiers, as described in
 the appropriate section.  The general syntax is ``:rolename:`content```.
 
+reST 也支持自定"文本诠释规则",
+这意味着,任意由指定字符封闭的文本都可以用特定的方式来诠释.
+Sphinx 就用这种形式来提供语义标记和交叉引用,
+一般语法形如: ``:规则名:`内容```
+
 Standard reST provides the following roles:
+标准 reST 提供以下规则:
 
-* :durole:`emphasis` -- alternate spelling for ``*emphasis*``
-* :durole:`strong` -- alternate spelling for ``**strong**``
-* :durole:`literal` -- alternate spelling for ````literal````
-* :durole:`subscript` -- subscript text
-* :durole:`superscript` -- superscript text
-* :durole:`title-reference` -- for titles of books, periodicals, and other
-  materials
+* :durole:`emphasis` -- ``*emphasis*`` 的替代拼写
+* :durole:`strong` -- ``**strong**``  的替代拼写
+* :durole:`literal` -- ````literal````  的替代拼写
+* :durole:`subscript` -- 下标
+* :durole:`superscript` -- 上标
+* :durole:`title-reference` -- 书籍/期刊/及其他材料的标题
 
-See :ref:`inline-markup` for roles added by Sphinx.
 
+参考: :ref:`inline-markup` Sphinx 追加的规则
 
-Lists and Quote-like blocks
----------------------------
+
+列表和引用块 Lists and Quote-like blocks
+------------------------------------------------------
 
 List markup (:duref:`ref <bullet-lists>`) is natural: just place an asterisk at
 the start of a paragraph and indent properly.  The same goes for numbered lists;
 they can also be autonumbered using a ``#`` sign::
+列表标记(:duref:`参考 <bullet-lists>`): 只要自然的在段落的开始放置一个星号并正确缩进.
+这同样适用于带编号的列表;
+也可以使用``#``签署自动编号::
 
    * This is a bulleted list.
    * It has two items, the second
 Nested lists are possible, but be aware that they must be separated from the
 parent list items by blank lines::
 
+嵌套的列表是允许的但必须用空行同父列表分离开::
+
    * this is
    * a list
 
 
    * and here the parent list continues
 
-Definition lists (:duref:`ref <definition-lists>`) are created as follows::
+定义列表(:duref:`参考 <definition-lists>`) 如下创建::
 
    term (up to a line of text)
       Definition of the term, which must be indented
       Description.
 
 Note that the term cannot have more than one line of text.
+注意, 条目不能多行.
 
 Quoted paragraphs (:duref:`ref <block-quotes>`) are created by just indenting
 them more than the surrounding paragraphs.
+创建引用段落 (:duref:`参考 <block-quotes>`)只需要用缩进和其它段落区分即可.
 
-Line blocks (:duref:`ref <line-blocks>`) are a way of preserving line breaks::
+线块 (:duref:`ref <line-blocks>`) 是保留换行符的一种方法::
 
    | These lines are
    | broken exactly like in
    | the source file.
 
-There are also several more special blocks available:
+还有其它特殊文本块形式是支持的:
 
-* field lists (:duref:`ref <field-lists>`)
-* option lists (:duref:`ref <option-lists>`)
-* quoted literal blocks (:duref:`ref <quoted-literal-blocks>`)
-* doctest blocks (:duref:`ref <doctest-blocks>`)
+* 字段列表 (field lists :duref:`参考 <field-lists>`)
+* 选项列表 (option lists :duref:`参考 <option-lists>`)
+* 引述文本块 (quoted literal blocks :duref:`参考 <quoted-literal-blocks>`)
+* 文本测试块 (doctest blocks :duref:`参考 <doctest-blocks>`)
 
 
-Source Code
------------
+源代码 Source Code
+---------------------------------
 
-Literal code blocks (:duref:`ref <literal-blocks>`) are introduced by ending a
-paragraph with the special marker ``::``.  The literal block must be indented
-(and, like all paragraphs, separated from the surrounding ones by blank lines)::
+代码文本块  (:duref:`参考 <literal-blocks>`) 由末尾是特殊标记 ``::`` 的段落引发.
+整个代码文本块必须缩进
+(同所有的段落一样,使用空白行和周围文本完成分隔)::
 
    This is a normal text paragraph. The next paragraph is a code sample::
 
 
    This is a normal text paragraph again.
 
-The handling of the ``::`` marker is smart:
+``::`` 标记是智能处置的:
 
 * If it occurs as a paragraph of its own, that paragraph is completely left
   out of the document.
+  如果它作为它自己的段落时,该段是彻底离开
+  出的文件。
 * If it is preceded by whitespace, the marker is removed.
+如果它是由前面的空白,标记将被删除。
 * If it is preceded by non-whitespace, the marker is replaced by a single
   colon.
-
+如果它是由非空白之前,更换标记由单一
+  冒号。
+  
 That way, the second sentence in the above example's first paragraph would be
 rendered as "The next paragraph is a code sample:".