Skip to main content

A Sphinx plugin for documenting grammars

Project description

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

Requirements

  • python >= 3.12
  • sphinx >= 8.0

Installation

pip install sphinx-syntax

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_syntax-1.0.0.post1.tar.gz (146.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_syntax-1.0.0.post1-py3-none-any.whl (132.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_syntax-1.0.0.post1.tar.gz.

File metadata

  • Download URL: sphinx_syntax-1.0.0.post1.tar.gz
  • Upload date:
  • Size: 146.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_syntax-1.0.0.post1.tar.gz
Algorithm Hash digest
SHA256 701ebf64ef504e472e06fd65e4239764ab8229cf1367c7d8de238dc915b4d3a4
MD5 ec9ca261422082cef0b5c7c23ebb5968
BLAKE2b-256 ba2a1748e074aca77bad24a5a91fe0e18559c8cde10528653a6343b963ece125

See more details on using hashes here.

File details

Details for the file sphinx_syntax-1.0.0.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_syntax-1.0.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 357c3c1d3f19f581ca3ade1536e5666bf871f5fce47772200e36691965375619
MD5 2334e54340568f8f270a05603231f17e
BLAKE2b-256 cf99ec71a9ec513c764dfa8136d48ae81fc901f33f231e9dbe521fd2defb0530

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page