survos/doc-bundle

Build Sphinx documentation for a Symfony project, using Twig templates

1.5.378 2024-07-23 22:01 UTC

Requires

• php: ^8.1
• symfony/config: ^6.4 || ^7.0
• symfony/console: ^6.4 || ^7.0
• symfony/dependency-injection: ^6.4 || ^7.0
• symfony/finder: ^6.4 || ^7.0
• symfony/http-kernel: ^6.4 || ^7.0
• symfony/options-resolver: ^6.4 || ^7.0
• twig/twig: ^3.4

Requires (Dev)

• behat/behat: ^3.13
• friends-of-behat/symfony-extension: ^2.4
• phpstan/phpstan: ^1.8

Conflicts

• survos/api-grid-bundle: <1.2.57
• survos/auth-bundle: <1.2.57
• survos/barcode-bundle: <1.2.57
• survos/bootstrap-bundle: <1.2.57
• survos/command-bundle: <1.2.57
• survos/core-bundle: <1.2.57
• survos/crawler-bundle: <1.2.57
• survos/faker-bundle: <1.2.57
• survos/grid-bundle: <1.2.57
• survos/grid-group-bundle: <1.2.57
• survos/html-prettify-bundle: <1.2.57
• survos/import-bridge: <1.2.57
• survos/inspection-bundle: <1.2.57
• survos/location-bundle: <1.2.57
• survos/maker-bundle: <1.2.57
• survos/providence-bundle: <1.2.57
• survos/ruler-bundle: <1.2.57
• survos/stripe-product: <1.2.57
• survos/tree-bundle: <1.2.57
• survos/wiki-bundle: <1.2.57
• survos/workflow-helper-bundle: <1.2.57

MIT

• Tac Tacelosky

README

Symfony Bundle that provides some utilities for creating Spinx documentation for a Symfony project.

First, setup Sphinx

sudo apt-get install python3-sphinx
pip install sphinx_rtd_theme
pip install sphinx_fontawesome

composer req survos/doc-bundle

Put the .rst.twig files in templates/docs.

{# index.rst.twig #}
{{ rst_h(1, 'Welcome to Jardinio!') }}

The goal of this project is to provide plant management for botanical gardens, primarily involving
inventory (including samples and seeds) and maybe visitor tours.  It uses QR codes throughout the system.

.. toctree::
    :maxdepth: 2
    :caption: Contents:

.. fa:: check

{{ rst_h(2,'Administration') }}

The administrative portal allows managers to gardens


.. toctree::
    :maxdepth: 1

    quick-start
    tutorial

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`

cat tutorial.rst.twig

{{ rst_h(1, 'Tutorial') }}

{{ rst_h(2, 'create_account'|trans|title) }}
{{ rst_h(2, 'create_project'|trans|title) }}
{{ rst_h(2, 'add_a_plant'|trans|title) }}



{{ rst_h(3, 'add_a_plant'|trans|title) }}

.. fa:: check

bin/console survos:build-docs
cd docs
make html