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 =======
섹션(secion)은 이렇게 정리되어야 해요.
index.rst(contains links to internal files)
예를 들어 이렇게 되죠.
섹션 내용은 모두 폴더 안에 들어가게 돼요. 모든 섹션은
index.rst 목차 파일이랑
introduction.rst 소개 파일을 가져요.
목차는 두 단계의 깊이(depth)를 가져야 해요.
.. toctree:: :maxdepth: 2 introduction.rst perspective.rst depth_of_field.rst