模板

    每个操作员应根据内容的长度接收自己的标题或页面。在开始时应有一个参考警告,记录操作员的上下文:

    面板应按自己的标题记录,嵌套面板应使用降低的标题级别。每个小组可根据文件的长度和/或小组的数量有自己的网页。切换显示给用户的属性的展开菜单应被视为子面板:

    1. ===========
    2. Nested Panel Title
    3. ------------------

    应使用定义列表记录属性。基于其他属性隐藏的属性应使用嵌套定义:

    选择菜单应使用以下语法记录:

    1. General description of the menu.
    2. :Menu Item: Menu Item Definition.
    3. :Menu Item: Menu Item Definition.
    4. :Menu Item: Menu Item Definition.

    节点应始终有三个标题输入、属性和输出,如果节点没有,则注明缺勤。在页面的末尾可以是一个可选的示例部分:

    通用章节结构如下:

      • introduction.rst

      • section_1.rst

      • section_2.rst

    例如:

    • rendering/

      • cycles/

        • introduction.rst

        • materials/

          • introduction.rst

          • volumes.rst

    这样做是为了将同一章节的内容包含在一个文件夹内。理想的情况下每个章节都应该有一个 index.rst (包含该章节目录)和一个 introduction.rst 介绍该章节内容。

    默认情况下,目录需显示两级深度:

    1. .. toctree::
    2. :maxdepth: 2
    3. introduction.rst
    4. depth_of_field.rst