Skip to main content

A Sphinx plugin for documenting grammars

Project description

Sphinx plugin for Lua and Lua Language Server

A comprehensive Sphinx extension 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.tar.gz (146.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.0-py3-none-any.whl (132.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_syntax-1.0.0.tar.gz
  • Upload date:
  • Size: 146.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.0.tar.gz
Algorithm Hash digest
SHA256 024268b574400180353b75c308d7e53693a3942b70c931e0ef13a03e16de86d0
MD5 06c03c4089f3076cb6772920420ac93a
BLAKE2b-256 884e452be14256b99924f6e39396f4ef8ebe3cefab415a128d79b10d29f478d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_syntax-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 132.3 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 88883b7e5e50388d8d77ba5f84a3d3c11f1810fe26670bd639fe4f505599e0a1
MD5 8151ea98860d6c451e0de24a0d504442
BLAKE2b-256 cb5f6a606d459a9a56196a04c9ee0cef3b86816021dca50e0d7d131d06a1a9ae

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