survos/doc-bundle

使用Twig模板为Symfony项目构建Sphinx文档

资助包维护!
kbond

安装: 671

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 0

开放问题: 0

类型:symfony-bundle

1.5.340 2024-07-23 22:01 UTC

This package is auto-updated.

Last update: 2024-09-24 13:45:04 UTC


README

Symfony Bundle,提供了一些用于创建Symfony项目Sphinx文档的实用工具。

首先,设置Sphinx

sudo apt-get install python3-sphinx
pip install sphinx_rtd_theme
pip install sphinx_fontawesome
composer req survos/doc-bundle

将.rst.twig文件放在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