模板

以下指南提供了接口元素和目录的模式。

操作菜单

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

  1. .. admonition:: Reference
  2.    :class: refbox
  4.    :Mode:      Edit Mode
  5.    :Menu:      :menuselection:`Curve --> Snap`
  6.    :Shortcut:  :kbd:`Shift-S`

面板

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

  1. Panel Title
  2. ===========
  4. Nested Panel Title
  5. ------------------

属性

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

  1. Property
  2.    Property description.
  4.    Hidden Property
  5.       Hidden property description.

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

  1. Menu Label
  2.    General description of the menu.
  4.    :Menu Item: Menu Item Definition.
  5.    :Menu Item: Menu Item Definition.
  6.    :Menu Item: Menu Item Definition.

节点

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

  1. **********
  2. World Node
  3. **********
  5. .. figure:: /images/render_shader-nodes_output_world_node.png
  6.    :align: right
  8.    The World node.
  10. Introduction and general use case(s).
  13. Inputs
  14. ======
  16. This node has no inputs.
  19. Properties
  20. ==========
  22. This node has no properties.
  25. Outputs
  26. =======
  28. This node has no outputs.
  31. Example
  32. =======

目录布局

通用章节结构如下：

  • 目录名称/

    • index.rst (包含内部文件链接)

    • introduction.rst

    • section_1.rst

    • section_2.rst

例如：

  • rendering/

    • index.rst

    • cycles/

      • index.rst

      • introduction.rst

      • materials/

        • index.rst

        • introduction.rst

        • volumes.rst

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

目录

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

  1. .. toctree::
  2.    :maxdepth: 2
  4.    introduction.rst
  5.    perspective.rst
  6.    depth_of_field.rst