Bundle Doc Structure

Wouter J edited this page Sep 13, 2013 · 3 revisions

All bundle documentation MUST follow/update these structure/files:

bundles/
    bundle_name/
        index.rst
        introduction.rst
        other_articles.rst
    ...
    map.rst.inc
    index.rst
reference/
    configuration/
        bundle_name.rst
    map.rst.inc
    index.rst

bundles/bundle_name/introduction.rst

This file contains the introduction article. After this, the user should know enough about the bundle to use it. The main template:

BundleName
==========

    The BundleName provides tools... (short introduction, also contained in the README file)

Installation
------------

You can install the bundle in 2 different ways:

* Use the official Git repository (https://github.com/symfony-cmf/BundleName);
* Install it via Composer (``symfony-cmf/bundle-name`` on `Packagist`_).

Usage
-----

The usage stuff...

.. _`Packagist`: https://packagist.org/packages/symfony-cmf/bundle-name-bundle

bundles/bundle_name/other_articles.rst

More advanced articles are placed in seperate articles within the bundle docs. The introduction article contains a link to these articles

bundles/bundle_name/index.rst

BundleName
==========

.. toctree::
    :maxdepth: 2

    introduction
    other_articles

bundles/map.rst.inc

.. ...

* :doc:`bundle_name/index`

  * :doc:`bundle_name/introduction`
  * :doc:`bundle_name/other_articles`

bundles/index.rst

Bundles
=======
.. ...

.. toctree::
    :hidden:

    bundle_name/index

reference/configuration/bundle_name.rst

For an example, see http://symfony.com/doc/master/cmf/reference/configuration/routing.html

reference/index.rst

Reference
=========

.. ...

.. toctree::
    :hidden:

    configuration/bundle_name

reference/map.rst.inc

* **Configuration**

.. ...

  * :doc:`configuration/bundle_name`
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.