模板
Each operator should receive its own heading or page based on the length of the content. At the start should be a reference admonition documenting the context of the operator:
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:
===========
Nested Panel Title
------------------
Properties should be documented using definition lists. Properties that are hidden based on other properties should used nested definitions:
Select menus should be documented using the following syntax:
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:
通用章节结构如下:
-
introduction.rst
section_1.rst
section_2.rst
例如:
rendering/
cycles/
introduction.rst
materials/
introduction.rst
volumes.rst
这样做是为了将同一章节的内容包含在一个文件夹内。理想的情况下每个章节都应该有一个 index.rst
(包含该章节目录)和一个 introduction.rst
介绍该章节内容。
默认情况下,目录需显示两级深度:
.. toctree::
:maxdepth: 2
introduction.rst
depth_of_field.rst