Templates
The following guide provides patterns for interface elements and directories.
Paneles
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
------------------
Propiedades
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.
Nodos
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
=======
Disposición del Directorio
Las secciones generalmente deberían ser estructuradas como sigue:
directory_name/
index.rst
(contiene enlaces a archivos internos)introduccion.rst
seccion_1.rst
seccion_2.rst
Por ejemplo:
rendering/
index.rst
cycles/
index.rst
introduccion.rst
materials/
index.rst
introduccion.rst
volumenes.rst
La idea es meter todo el contenido de una sección dentro de una carpeta. Idealmente cada sección debería tener un index.rst
(conteniendo el TOC para esa sección) y un introduction.rst
a los contenidos de la sección.
Tabla de Contenidos
Por defecto, una tabla de contenidos debería mostrar dos niveles de profundidad:
.. toctree::
:maxdepth: 2
introduction.rst
perspective.rst
depth_of_field.rst