模板#

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

操作菜单#

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

.. admonition:: Reference
   :class: refbox

   :Mode:      Edit Mode
   :Menu:      :menuselection:`Curve --> Snap`
   :Shortcut:  :kbd:`Shift-S`

面板#

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

Panel Title
===========

Nested Panel Title
------------------

属性#

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

Property
   Property description.

   Hidden Property
      Hidden property description.

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

Menu Label
   General description of the menu.

   :Menu Item: Menu Item Definition.
   :Menu Item: Menu Item Definition.
   :Menu Item: Menu Item Definition.

节点#

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

**********
World Node
**********

.. figure:: /images/render_shader-nodes_output_world_node.png
   :align: right

   The World node.

Introduction and general use case(s).


Inputs
======

This node has no inputs.


Properties
==========

This node has no properties.


Outputs
=======

This node has no outputs.


Example
=======

目录布局#

通用章节结构如下：

  • 目录名称/

    • 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 介绍该章节内容。

目录#

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

.. toctree::
   :maxdepth: 2

   introduction.rst
   perspective.rst
   depth_of_field.rst