Templates (Modèles)

Le guide suivant fournit des modèles pour les éléments d’interface et les répertoires.

Menus Opérateurs

Chaque opérateur doit recevoir son propre titre ou page en fonction de la longueur du contenu. Au début cela devrait être un avertissement de référence documentant le contexte de l’opérateur :

.. admonition:: Reference
   :class: refbox

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

Panneaux

Les panneaux doivent être documentés par leur propre titre, les panneaux imbriqués doivent utiliser des niveaux de titre décroissants. Chaque panneau peut avoir sa propre page en fonction de la longueur de la documentation et / ou du nombre de panneaux. Les menus développés qui basculent entre les propriétés présentées à l’utilisateur doivent être traités comme des sous-panneaux :

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

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

Propriétés

Les propriétés doivent être documentées à l’aide de listes de définitions. Les propriétés qui sont masquées en fonction d’autres propriétés doivent utiliser des définitions imbriquées :

Property
   Property description.

   Hidden Property
      Hidden property description.

Les menus de sélection doivent être documentés en utilisant la syntaxe suivante :

Menu Label
   General description of the menu.

   :Menu Item: Menu Item Definition.
   :Menu Item: Menu Item Definition.
   :Menu Item: Menu Item Definition.

Nœuds (Nodes)

Les nœuds doivent toujours avoir trois titres, Inputs , Properties et Output avec une note d’absence si le nœud n’en a pas. À la fin de la page on peut avoir une section d’Example(s) facultative :

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

Structure de dossier

De façon générale, les sections devraient être structurées de la manière suivante :

directory_name/
- index.rst (contient des liens aux fichiers internes)
- introduction.rst
- section_1.rst
- section_2.rst

Par exemple :

rendering/
- index.rst
- cycles/
  - index.rst
  - introduction.rst
  - materials/
    - index.rst
    - introduction.rst
    - volumes.rst

L’idée est de mettre tout le contenu d’une section dans un même dossier. Idéalement chaque section devrait avoir un index.rst (contenant la table des matières pour cette section) et un introduction.rst (introduisant) au contenu de la section.

Table des matières

Par défaut, une table des matières devrait montrer deux niveaux de profondeur :

.. toctree::
   :maxdepth: 2

   introduction.rst
   perspective.rst
   depth_of_field.rst

Join the 2%