Skip to main content

Pygments-based syntax highlighting for DELPH-IN formats.

Project description

# delphin.highlight

This module provides [Pygments][] [lexers](http://pygments.org/lexers) for the following [DELPH-IN][] formats:

  • [TDL][] – Type Description Language

  • [SimpleMRS][] – A popular serialization format for Minimal Recursion Semantics

In addition, a Pygments [style](http://pygments.org/docs/styles/) for MRS is available which helps highlight the interesting information in SimpleMRS.

# Examples

The SimpleMRS style is meant for console output, and works with both dark and light backgrounds:

![SimpleMRS on a dark background](images/mrs-dark.png)

![SimpleMRS on a light background](images/mrs-light.png)

The TDL lexer is used for [PyDelphin][]’s [Sphinx][]-based documentation:

![TDL highlighting from PyDelphin’s documentation](images/tdl.png)

# Installation and Requirements

This module is a [namespace package][] of [PyDelphin][], but it does not depend on any PyDelphin packages, rather it only depends on Pygments version 2.3.1 or higher. This means it can be used independently of PyDelphin.

This module can be installed via pip:

` console $ pip install delphin.highlight `

[namespace package]: https://docs.python.org/3/reference/import.html#namespace-packages

# Usage

While you can drop in the lexers into Pygments-capable applications like wikis or documentation sites, the console highlighting of SimpleMRS is provided by the [PyDelphin][] package via the delphin convert command.

[DELPH-IN]: http://www.delph-in.net [Pygments]: http://pygments.org [PyDelphin]: https://github.com/delph-in/pydelphin [SimpleMRS]: http://moin.delph-in.net/MrsRfc [Sphinx]: http://www.sphinx-doc.org/ [TDL]: http://moin.delph-in.net/TdlRfc

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

delphin.highlight-1.0.0.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

delphin.highlight-1.0.0-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page