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.1.tar.gz (220.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.2.1-py3-none-any.whl (134.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_syntax-1.2.1.tar.gz
  • Upload date:
  • Size: 220.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sphinx_syntax-1.2.1.tar.gz
Algorithm Hash digest
SHA256 4dd0119d63dbdd71824dda0748b6880a2067598d5571dd8374ee87fb28555b9c
MD5 4b2107f1e1bf5fb5fec18230c2d99ba9
BLAKE2b-256 d5dabe4e5e60c8707385c356d0adbfa99b13b2e2b3395ec321b3cd9a735de209

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sphinx_syntax-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bb88301e270f5062918ac64e567c4ef681f3ddd55b24683ce56e3ac3ca35d817
MD5 aeaacc15689735360d6d4ba6cffb8466
BLAKE2b-256 ac2632c553454bef0639c28d4f6c1d0d52a8929c19d3d3b188d98e08f4752c9d

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