Шаблоны#
В следующем руководстве представлены шаблоны для элементов интерфейса и каталогов.
Панели#
Панели должны быть документированы собственным заголовком, вложенные панели должны использовать понижающиеся уровни заголовков. Каждая панель может иметь собственную страницу в зависимости от объема документации и/или количества панелей. Расширенные (expanded) меню, которые переключают свойства, отображаемые пользователю, следует рассматривать как подпанели:
Panel Title
===========
Nested Panel Title
------------------
Свойства#
Свойства должны быть документированы с использованием списков определений (definition lists). Свойства, которые скрыты на основе других свойств, должны использовать вложенные определения:
Property
Property description.
Hidden Property
Hidden property description.
Меню выбора следует документировать с использованием следующего синтаксиса:
Menu Label
General description of the menu.
:Menu Item: Menu Item Definition.
:Menu Item: Menu Item Definition.
:Menu Item: Menu Item Definition.
Ноды (nodes)#
Ноды всегда должны иметь три заголовка: входы, свойства и выходы с пометкой об отсутствии, если у ноды их нет. В конце страницы может быть необязательный раздел с примерами:
**********
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
=======
Макет каталога#
В основном, разделы должны структурироваться следующим образом:
directory_name/
index.rst
(содержит ссылки на внутренние файлы)introduction.rst
section_1.rst
section_2.rst
Например:
rendering/
index.rst
cycles/
index.rst
introduction.rst
materials/
index.rst
introduction.rst
volumes.rst
Идея заключается в том, чтобы заключить всё содержимое раздела внутри каталога. В идеале каждый раздел должен иметь файлы index.rst
(содержащие оглавление данного раздела) и introduction.rst
(знакомство) с содержанием раздела.
Содержание#
По умолчанию содержание будет показываться глубиной в два уровня:
.. toctree::
:maxdepth: 2
introduction.rst
perspective.rst
depth_of_field.rst