Metadata-Version: 2.4
Name: sphinx-syntax
Version: 1.1.0
Summary: A Sphinx plugin for documenting grammars
Author-email: Tamika Nomara <taminomara@gmail.com>
License-Expression: MIT
Project-URL: Documentation, https://sphinx-syntax.readthedocs.io/en/stable/
Project-URL: Issues, https://github.com/sphinx-contrib/syntax/issues
Project-URL: Source, https://github.com/sphinx-contrib/syntax/
Project-URL: Changelog, https://github.com/sphinx-contrib/syntax/blob/main/CHANGELOG.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Developers
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: syntax-diagrams<2.0,>=1.0.0
Requires-Dist: sphinx<9.0,>=8.0
Requires-Dist: PyYAML<7.0,>=6.0
Requires-Dist: antlr4-python3-runtime<4.14,>=4.13
Dynamic: license-file

# Sphinx plugin for documenting language grammars

Features:

- A new domain with `grammar` and `rule` directives called `syntax`.

- Directives for rendering syntax diagrams.

- Directive for extracting documentation comments and rendering docs and
  diagrams from ANTLR4 and Bison/YACC source files.

## Resources

- [Documentation](https://sphinx-syntax.readthedocs.io/en/stable/)
- [Quickstart](https://sphinx-syntax.readthedocs.io/en/stable/quickstart.html)
- [Example output](https://sphinx-syntax.readthedocs.io/en/stable/example-output.html)

## Requirements

- python >= 3.12
- sphinx >= 8.0

## Installation

```sh
pip install sphinx-syntax
```
