survos/doc-bundle
Build Sphinx documentation for a Symfony project, using Twig templates
Maintainers
Fund package maintenance!
2.10.19
2026-06-17 12:11 UTC
Requires
- php: ^8.5
- davidbadura/markdown-builder: ^1.1
- jawira/doctrine-diagram-bundle: ^1.1
- jawira/doctrine-diagram-contracts: ^1 || ^2
- nadar/php-composer-reader: ^2.0
- survos/kit-bundle: ^2.5
- symfony/config: ^8.1
- symfony/console: ^8.1
- symfony/dependency-injection: ^8.1
- symfony/filesystem: ^8.1
- symfony/finder: ^8.1
- symfony/http-kernel: ^8.1
- symfony/options-resolver: ^8.1
- twig/twig: ^3.4
Requires (Dev)
- phpstan/phpstan: ^2.0
- phpunit/phpunit: ^13.0
- symfony/framework-bundle: ^8.1
- symfony/panther: ^2.2
- symfony/routing: ^8.1
Suggests
- behat/behat: For running the Behat feature tests (no Symfony 8 compatible release yet)
- friends-of-behat/symfony-extension: Symfony integration for Behat (requires behat/behat)
- survos/state-bundle: Richer doc:workflows diagrams that honor Survos place/transition metadata
- symfony/process: Lets doc:workflows render .svg diagrams via graphviz "dot"
- symfony/workflow: Required by the doc:workflows command to document registered workflows
Provides
None
Conflicts
None
Replaces
None
MIT 998706fb22d8ae4718ff72f976ec8e3193adc0ea
- Tac Tacelosky <tacman.woop@gmail.com>
This package is auto-updated.
Last update: 2026-06-22 19:41:33 UTC
README
Integration with Asciinema (ciine)
Workflow for ciine after installing the bundle.
set up the filename template. This is global
set up .bashrc so that rec or ciine runs
export CIINE_PATH=~/g/sites/showcase/casts export CIINE_PATH=~/g/sites/showcase/casts/${PWD##*/}/$(date '+%s').cast ciine rec $CIINE_PATH
Symfony Bundle that provides some utilities for creating Spinx documentation for a Symfony project.
First, setup Sphinx
sudo apt-get install python3-sphinx pipx install sphinx_rtd_theme pipx 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 doc:build
cd docs
make html