comparison README.rst @ 272:9afbc584a444

Semantic markup and style in the README
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 19 May 2026 23:21:43 +0200
parents a350b921b9bd
children 69a5868b30fd
comparison
equal deleted inserted replaced
271:a350b921b9bd 272:9afbc584a444
30 30
31 31
32 Installation 32 Installation
33 ============ 33 ============
34 34
35 The lexers are available as a `Python`_ wheel package:: 35 The lexers are available as a `Python`_ wheel package:
36 36
37 pip install pygments-lexer-pseudocode2 37 .. code-block:: shell
38 38
39 Alternatively, to build from the source code repository:: 39 pip install pygments-lexer-pseudocode2
40 40
41 python -m build 41 Alternatively, to build from the source code repository:
42
43 .. code-block:: shell
44
45 python -m build
42 46
43 47
44 Usage 48 Usage
45 ===== 49 =====
46 50
48 register itself with the plugin system of Pygments. 52 register itself with the plugin system of Pygments.
49 Their respective aliases and filename extensions are made known to Pygments. 53 Their respective aliases and filename extensions are made known to Pygments.
50 54
51 Usage is easy: 55 Usage is easy:
52 56
53 Pygmentizing a file with a known file extension:: 57 Pygmentizing a file with a known file extension:
54 58
55 pygmentize document.algpseudocode 59 .. code-block:: shell
60
61 pygmentize document.algpseudocode
56 62
57 Or you can manually select the Pseudocode lexer you want to use by 63 Or you can manually select the Pseudocode lexer you want to use by
58 using a command line flag:: 64 using a command line flag:
59 65
60 pygmentize -l algpseudocode somefile 66 .. code-block:: shell
61 67
62 Within `Sphinx`_ use a lexer like this:: 68 pygmentize -l algpseudocode somefile
63 69
64 .. code-block:: algpseudocode 70 Within `Sphinx`_ use a lexer like this:
71
72 .. code-block:: none
73
74 .. code-block:: algpseudocode
65 75
66 76
67 Licenses 77 Licenses
68 ======== 78 ========
69 79