Plantillas

La siguiente guía proporciona patrones para directorios y elementos de interfaz.

Menús de Operador

Cada operador debe recibir su propio encabezado o página en función de la longitud del contenido. Al principio debe haber una advertencia de referencia que documente el contexto del operador:

.. admonition:: Reference
   :class: refbox

   :Mode:      Edit Mode
   :Menu:      :menuselection:`Curve --> Snap`
   :Shortcut:  :kbd:`Shift-S`

Paneles

Los paneles deben estar documentados por su propio encabezado, los paneles anidados deben usar niveles de encabezado 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 deben tratarse como sub-paneles:

Panel Title
===========

Nested Panel Title
------------------

Propiedades

Las propiedades deben documentarse mediante listas de definiciones. Las propiedades que están ocultas en función de otras propiedades deben usar definiciones anidadas:

Property
   Property description.

   Hidden Property
      Hidden property description.

Los menús seleccionados deben 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 deben tener tres encabezados de entradas, propiedades y salidas con una nota de ausencia si el nodo no tiene ninguna. Al final de la página puede haber una sección de ejemplo(s) opcional(es):

**********
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 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