survos/doc-bundle
Composer 安装命令:
composer require survos/doc-bundle
包简介
Build Sphinx documentation for a Symfony project, using Twig templates
README 文档
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
survos/doc-bundle 适用场景与选型建议
survos/doc-bundle 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 1.72k 次下载、GitHub Stars 达 0, 最近一次更新时间为 2022 年 09 月 19 日, 在 PHP 生态内属于活跃度较高的组件。
我们在过去多个企业项目中使用过 survos/doc-bundle 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 survos/doc-bundle 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
统计信息
- 总下载量: 1.72k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 18
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2022-09-19