README.md

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
• Quickstart
• Example output

Requirements

• python >= 3.12
• sphinx >= 8.0

Installation

pip install sphinx-syntax