Русская документация Symfony2 на SymfonyGuru

Дата последнего обновления: 2012-05-20.

Формат документации

Документация Symfony2 использует reStructuredText как язык разметки и Sphinx для создания вывода (HTML, PDF и т. д.).

reStructuredText

reStructuredText это “легкочитаемый, что видишь то и получишь, синтаксис разметки открытым текстом и система анализа”.

Узнайте больше о его синтаксисе, прочитав Symfony2 documents или reStructuredText Primer на web сайте Sphinx.

Если вы знакомы с Markdown, будьте осторожны, т. к. некоторые вещи очень знакомы, но отличаются:

  • Списки начинаются с начала строки (необходимость отступа отсутствует);
  • Встроенные блоки кода используют двойные кавычки (``как здесь``).

Sphinx

Sphinx - это система сборки, добавляющая полезные инструменты для создания документации из документов reStructuredText. Она добавляет указания и роли интерпретированного текста к стандартной reST markup.

Подсветка синтаксиса

Все примеры кода подсвечиваются по умолчанию как язык PHP. Вы можете изменить их через директиву code-block:

.. code-block:: yaml

    { foo: bar, bar: { foo: bar, bar: baz } }

Если ваш PHP код начинается с <?php, тогда используйте html+php как подсвечиваемый псевдо-язык:

.. code-block:: html+php

    <?php echo $this->foobar(); ?>

Примечание

Список поддерживаемых языков доступен на Pygments website.

Блоки конфигураций

Всякий раз как вы показываете конфигурацию, используйте директиву configuration-block чтобы отразить конфигурацию во всех поддерживаемых форматах (PHP, YAML и XML):

.. configuration-block::

    .. code-block:: yaml

        # Configuration in YAML

    .. code-block:: xml

        <!-- Configuration in XML //-->

    .. code-block:: php

        // Configuration in PHP

Предыдущая reST разметка отобразится следующим образом:

  • YAML
    # Configuration in YAML
  • XML
    <!-- Configuration in XML //-->
  • PHP
    // Configuration in PHP

Текущий список поддерживаемых форматов:

Формат разметки Отображается
html HTML
xml XML
php PHP
yaml YAML
jinja Twig
html+jinja Twig
jinja+html Twig
php+html PHP
html+php PHP
ini INI
php-annotations Аннотации