survos/doc-bundle
最新稳定版本:2.0.96
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 survos:build-docs
cd docs
make html
统计信息
- 总下载量: 1.38k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 1
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2022-09-19