模板
The following guide provides patterns for interface elements and directories.
面板
Panels should be documented by their own heading, nested panels should use decreasing heading levels. Each panel could have its own page based on the length of documentation and/or the amount of panels. Expanded menus that toggle what properties are presented to the user should be treated like subpanels:
Panel Title
===========
Nested Panel Title
------------------
属性
Properties should be documented using definition lists. Properties that are hidden based on other properties should used nested definitions:
Property
Property description.
Hidden Property
Hidden property description.
Select menus should be documented using the following syntax:
Menu Label
General description of the menu.
:Menu Item: Menu Item Definition.
:Menu Item: Menu Item Definition.
:Menu Item: Menu Item Definition.
节点
Nodes should always have three headings inputs, properties and outputs with a note of absence if the node has none. At the end of the page can be an optional example(s) section:
**********
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