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.1.post1.tar.gz (147.8 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.1.post1-py3-none-any.whl (133.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_syntax-1.0.1.post1.tar.gz
  • Upload date:
  • Size: 147.8 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.1.post1.tar.gz
Algorithm Hash digest
SHA256 a46a2c3d025104378c77b8c927ae85b6945e193620a4716c3cb0dbe71f31a427
MD5 953cb003060a10ff43eafbcfde6c7a53
BLAKE2b-256 c20cf8653d9f16b0dd97e2c8e4b80c29f214a76b2ce930243468deae2585e27e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_syntax-1.0.1.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 13a59e9c968250eae963af5ce6e5f97c9847a0e00af4b65b2da401837aed2bf0
MD5 8490d9b1ac3e0a61980abeea8a11d6e9
BLAKE2b-256 18e5aa57a5da2fd0d8f3c472583c9d8dd82335d5cb1c6b52db96f57dbb1c6660

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