Sphinx domain and autodoc for Antlr4 grammars
Project Links
Meta
Author: Tamika Nomara
Classifiers
Development Status
- 5 - Production/Stable
Programming Language
- Python :: 3 :: Only
- Python :: 3
- Python :: 3.7
- Python :: 3.8
License
- OSI Approved :: MIT License
Framework
- Sphinx
- Sphinx :: Domain
- Sphinx :: Extension
Topic
- Software Development :: Documentation
- Documentation
- Documentation :: Sphinx
Sphinx plugin for Antlr4
Sphinx-A4Doc is deprecated, please use Sphinx-Syntax instead.
See migration guide for more info.
Resources
Changelog
v1.7.0
- End of support announcement.
v1.6.0
- Support LaTeX builder.
v1.5.0
- Fixed position of text in diagram nodes in Firefox.
- Added an option to set custom classes to diagram nodes:
//@ doc:css-class
.
v1.4.0
- Fixed compatibility with
singlehtml
mode (see #15).
v1.3.0
- Fixed python 3.9 compatibility issue (by @sandrotosi).
v1.2.2, v1.2.3, v1.2.4
- No functional changes, just setting up CI to push PyPI releases automatically.
v1.2.1
- Fixed integration with intersphinx.
v1.2.0:
- Renamed
conf.py
settings:a4_autodoc_*
becamea4_autogrammar_*
. - Added support for section comments in grammar files.
- Added flexible settings to control how literal lexer rules are rendered.
- Added setting to convert rule names from
CamelCase
todash-case
. - Fixed documentation comments are parsed incorrectly in some cases.
v1.0.1:
- Fixed absence of
.css
file for railroad diagrams.
v1.0.0:
- Initial release.
Sep 28, 2025
1.7.0
Dec 22, 2022
1.6.0
Dec 19, 2022
1.5.0
Dec 19, 2022
1.4.0
Oct 12, 2021
1.3.0
Dec 14, 2020
1.2.4
Dec 13, 2020
1.2.2
Mar 02, 2019
1.2.1
Mar 02, 2019
1.2.0
Dec 07, 2018
1.0.1
Nov 26, 2018
1.0.0