用于 Antlr4 语法的 Sphinx 域和自动文档
项目描述
Antlr4 的 Sphinx 插件
A4Doc 是一个用于记录 Antlr4 语法的 sphinx 插件。
它的主要目标是为 DSL 用户提供一些概述（生成的文档可能不包括编译器开发人员所必需的一些细微差别）。
A4Doc 的特点是：
- 一个带有语法和规则指令的新域，称为
a4； - 绘制铁路图的指令；
.g4用于从源文件中提取文档注释并呈现文档和图表的指令。
资源
要求
- 蟒蛇> = 3.7
- 狮身人面像 >= 1.8.0
安装
pip3 install sphinx-a4doc
用例
变更日志
v1.2.5
- 修复了 python 3.9 兼容性问题（由@sandrotosi 提供）。
v1.2.2、v1.2.3、v1.2.4
- 没有功能更改，只需设置 CI 以自动推送 PyPI 版本。
v1.2.1
- 修复了与 intersphinx 的集成。
v1.2.0：
- 重命名
conf.py设置：a4_autodoc_*成为a4_autogrammar_*. - 添加了对语法文件中的部分注释的支持。
- 添加了灵活的设置来控制文字词法分析器规则的呈现方式。
- 添加了将规则名称从 转换为 的
CamelCase设置dash-case。 - 在某些情况下，已修复的文档注释解析不正确。
v1.0.1：
- 修复
.css了铁路图文件缺失的问题。
v1.0.0：
- 初始发行。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
sphinx-a4doc-1.3.0.tar.gz
(96.9 kB
查看哈希)
内置分布
sphinx_a4doc-1.3.0-py3-none-any.whl
(97.7 kB
查看哈希)
关
sphinx_a4doc -1.3.0-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 1410b7e4b5974b7ea785debc291f2c4834f910bbe4f95e2e7a2bca8fac627648 |
|
| MD5 | 75234f4bf5f148cc1e2bc37ddbdf6a4e |
|
| 布莱克2-256 | e4a789e90bddc7ecd32ba753d9c2cf3f0d38fa1502c3050343758906b137eea9 |