pygments_plugin_vdm_lexer

Pygments lexer for VDM


Keywords
pygments, lexer, vdm
License
MIT
Install
pip install pygments_plugin_vdm_lexer==1.0

Documentation

Pygments lexer for VDMについて

VDMLexerの概要

VDMLexerは、 SphinxTrac で使われている、 シンタックスハイライトライブラリー Pygments のVDM用プラグインです。 このプラグインを使うと、SphinxでVDMコードを貼りつけた時に、予約語がハイライトして出力することができます。

VDMLexerのインストール

VDMLexerのインストールは以下のようにします。

  • 前提条件

    • Pythonがインストールされていること
    • Pythonのパッケージ管理ツールであるpipかeasy_installがインストールされていること
  • インストール

VDMLexerのビルド

% cd LexerDev

easy_install向けのeggを作成する場合

% python setup.py bdist_egg

これで、 pygments_plugin_vdm_lexer-1.0-py\.*.egg* がdistディレクトリ下にできます。

pip向けのwheelを作成する場合

% python setup.py bdist_wheel

これで、 pygments_plugin_vdm_lexer-1.0-py\-none-any.whl* がdistディレクトリ下にできます。

VDMLexerの使い方(Sphinxで使う場合)

VDMLexerを用いて、Sphinxでシンタックスハイライトをするには、以下のようにします。

.. literalinclude:: vdm/hoge.vpp
   :language: vdm

literalincludeを使わない場合は、以下のようにします。

.. code-block:: vdm

  class Hoge
  (中略)
  end Hoge