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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_syntax-1.1.0.tar.gz
  • Upload date:
  • Size: 150.4 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.1.0.tar.gz
Algorithm Hash digest
SHA256 55473e1b6c6a1b11f04467adb7a6e80243544641615764d33a1ca2fafb9195fd
MD5 dbaf47ed6bfbfba40dbafa4c00871423
BLAKE2b-256 5b47fe0168498548162dd732b9dddd6a227b87554c2b4cbeee1a40d8f2706cd5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_syntax-1.1.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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 466a814a62b2db9a74caa80279e5a7e7c738020ce56240f87a4c95b3dc5ae6ab
MD5 5c80f997cf7f28f1a705c4337b7d4be8
BLAKE2b-256 9b2e537e93535f9799c8389c219d084bfe3bec9432dada1720a55eba0f42acfa

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