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.2.0.tar.gz (150.7 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.2.0-py3-none-any.whl (134.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_syntax-1.2.0.tar.gz.

File metadata

  • Download URL: sphinx_syntax-1.2.0.tar.gz
  • Upload date:
  • Size: 150.7 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.2.0.tar.gz
Algorithm Hash digest
SHA256 d7079a44b70ba999287a950b8e131e0c77bf38c1f4ffd282e93a7d410b767776
MD5 67e91fd4507fde3a6bc753fa6551170b
BLAKE2b-256 f8b575895ef12e0d8a3fb75b05d5870309f8c0df816c6b69e8d9ccd2d0d82c8a

See more details on using hashes here.

File details

Details for the file sphinx_syntax-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: sphinx_syntax-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 134.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_syntax-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 05e6da3e416c27035519334526895db5b53a8fd68474bced8b8333a8a0bfb721
MD5 b71c62d5323c60663bb7109450da249f
BLAKE2b-256 21823fbe9b7a22a9d47365a8a21a34ffe33a11c6b44afd52cd45e3c4ba5bbe3d

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