# Sphinx plugin for Antlr4
A4Doc is a sphinx plugin for documenting Antlr4 grammars.
It’s primary target is to provide some overview for DSL users
(generated documentation may not include some nuances essential
for compiler developers).
A4Doc's features are:
- a new domain with grammar and rule directives called ``a4``;
- directives for rendering railroad diagrams;
- directive for extracting documentation comments and rendering docs and
diagrams from `.g4` source files.
<!--- cut --->
## Resources
- [Documentation](https://taminomara.github.io/sphinx-a4doc/)
- [Installation](https://taminomara.github.io/sphinx-a4doc/#installation)
- [Quickstart](https://taminomara.github.io/sphinx-a4doc/#quickstart)
- [Example output](https://taminomara.github.io/sphinx-a4doc/#example-output)
## Requirements
- python >= 3.7
- sphinx >= 1.8.0
## Installation
```sh
pip3 install sphinx-a4doc
```
## Use cases
- [Solidity specification](https://docs.soliditylang.org/en/latest/grammar.html)
- [7zip format specification](https://py7zr.readthedocs.io/en/latest/archive_format.html)
## Changelog
*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](https://github.com/taminomara/sphinx-a4doc/issues/15)).
*v1.3.0*
- Fixed python 3.9 compatibility issue (by [@sandrotosi](https://github.com/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_*` became `a4_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`` to ``dash-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.
Raw data
{
"_id": null,
"home_page": "https://github.com/taminomara/sphinx-a4doc",
"name": "sphinx-a4doc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sphinx antlr4 autodoc",
"author": "Tamika Nomara",
"author_email": "taminomara@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9f/63/c8a7973815bf7f2cef0f3dc30f1206f16e3722be036b3fad7cb9702e5252/sphinx-a4doc-1.6.0.tar.gz",
"platform": null,
"description": "# Sphinx plugin for Antlr4\n\nA4Doc is a sphinx plugin for documenting Antlr4 grammars.\n\nIt\u2019s primary target is to provide some overview for DSL users\n(generated documentation may not include some nuances essential\nfor compiler developers).\n\nA4Doc's features are:\n\n- a new domain with grammar and rule directives called ``a4``;\n- directives for rendering railroad diagrams;\n- directive for extracting documentation comments and rendering docs and\n diagrams from `.g4` source files.\n\n<!--- cut --->\n\n## Resources\n\n- [Documentation](https://taminomara.github.io/sphinx-a4doc/)\n- [Installation](https://taminomara.github.io/sphinx-a4doc/#installation)\n- [Quickstart](https://taminomara.github.io/sphinx-a4doc/#quickstart)\n- [Example output](https://taminomara.github.io/sphinx-a4doc/#example-output)\n\n## Requirements\n\n- python >= 3.7\n- sphinx >= 1.8.0\n\n## Installation\n\n```sh\npip3 install sphinx-a4doc\n```\n\n## Use cases\n\n- [Solidity specification](https://docs.soliditylang.org/en/latest/grammar.html)\n- [7zip format specification](https://py7zr.readthedocs.io/en/latest/archive_format.html)\n\n## Changelog\n\n*v1.6.0*\n\n- Support LaTeX builder.\n\n*v1.5.0*\n\n- Fixed position of text in diagram nodes in Firefox.\n- Added an option to set custom classes to diagram nodes: `//@ doc:css-class`.\n\n*v1.4.0*\n\n- Fixed compatibility with `singlehtml` mode (see [#15](https://github.com/taminomara/sphinx-a4doc/issues/15)).\n\n*v1.3.0*\n\n- Fixed python 3.9 compatibility issue (by [@sandrotosi](https://github.com/sandrotosi)).\n\n*v1.2.2, v1.2.3, v1.2.4*\n\n- No functional changes, just setting up CI to push PyPI releases automatically.\n\n*v1.2.1*\n\n- Fixed integration with intersphinx.\n\n*v1.2.0*:\n\n- Renamed `conf.py` settings: `a4_autodoc_*` became `a4_autogrammar_*`.\n- Added support for section comments in grammar files.\n- Added flexible settings to control how literal lexer rules are rendered.\n- Added setting to convert rule names from ``CamelCase`` to ``dash-case``.\n- Fixed documentation comments are parsed incorrectly in some cases.\n\n*v1.0.1*:\n\n- Fixed absence of `.css` file for railroad diagrams.\n\n*v1.0.0*:\n\n- Initial release.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx domain and autodoc for Antlr4 grammars",
"version": "1.6.0",
"split_keywords": [
"sphinx",
"antlr4",
"autodoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "7075482c681636835f71b472061d7f6e",
"sha256": "6eed513469becf0abb9f3443adcf427faf9af629e9b90222c1b3d44044fa165d"
},
"downloads": -1,
"filename": "sphinx_a4doc-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7075482c681636835f71b472061d7f6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 99039,
"upload_time": "2022-12-22T15:38:41",
"upload_time_iso_8601": "2022-12-22T15:38:41.517616Z",
"url": "https://files.pythonhosted.org/packages/1f/88/f204567a6560d3f15fa1203e2c7aabfedaa9640a0cdb62cf79d5008d8463/sphinx_a4doc-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "85594e3bdd65985968f076ef076c1195",
"sha256": "7457f14143970f48c7be41bad5b862af7621922f17086015aa1ec8a5ad96a02f"
},
"downloads": -1,
"filename": "sphinx-a4doc-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "85594e3bdd65985968f076ef076c1195",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 98102,
"upload_time": "2022-12-22T15:38:42",
"upload_time_iso_8601": "2022-12-22T15:38:42.750898Z",
"url": "https://files.pythonhosted.org/packages/9f/63/c8a7973815bf7f2cef0f3dc30f1206f16e3722be036b3fad7cb9702e5252/sphinx-a4doc-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-22 15:38:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "taminomara",
"github_project": "sphinx-a4doc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-a4doc"
}
JSON
