Plantillas¶
La siguiente guía proporciona patrones para directorios y elementos de interfaz.
Paneles¶
Los paneles deberán estar documentados con su propio título, los paneles anidados deberán usar niveles de subtítulos decrecientes. Cada panel podría tener su propia página, según la extensión de la documentación y/o la cantidad de paneles. Los menús expandidos que alternan qué propiedades se presentan al usuario deberán tratarse como subpaneles:
Panel Title
===========
Nested Panel Title
------------------
Propiedades¶
Las propiedades deberán documentarse mediante listas de definiciones. Las propiedades que estén ocultas, en función de otras propiedades, deberán usar definiciones anidadas:
Property
Property description.
Hidden Property
Hidden property description.
Los menús seleccionados deberán documentarse utilizando la siguiente sintaxis:
Menu Label
General description of the menu.
:Menu Item: Menu Item Definition.
:Menu Item: Menu Item Definition.
:Menu Item: Menu Item Definition.
Nodos¶
Los nodos siempre deberán tener tres encabezados para sus entradas, propiedades y salidas, con una nota de ausencia, en caso de que el nodo no tuviera ninguna. Al final de la página podrá haber una sección de ejemplos opcionales:
**********
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
=======
Estructura de directorios¶
Las secciones debería generalmente estar estructuradas como sigue:
nombre_de_directorio/
index.rst
(contendrá enlaces a archivos internos)introducción.rst
sección_1.rst
sección_2.rst
Por ejemplo:
rendering/
index.rst
cycles/
index.rst
introducción.rst
materials/
index.rst
introducción.rst
volumes.rst
La idea es colocar todo el contenido de una sección dentro de una carpeta. Idealmente cada sección debería tener un archivo index.rst
(conteniendo la tabla de contenidos de esa sección) y un archivo introducción.rst
para los contenidos de la sección.
Tabla de contenidos¶
De forma predefinida, una tabla de contenidos deberá mostrar dos niveles de profundidad:
.. toctree::
:maxdepth: 2
introduction.rst
perspective.rst
depth_of_field.rst