Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2

annotate README.rst @ 158:f08d77b8cbf7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document the default filter "raiseonerror" that is applied by Sphinx by default for lexers
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 08 May 2026 16:44:30 +0200
parents c4f6f5e771b0
children 6a7dace0141e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
1 .. -*- coding: utf-8 -*-
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
2
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
3 *****************************************
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
4 README -- Pseudocode Lexer for Pygments
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
5 *****************************************
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
6
145
c4f6f5e771b0 Also define the :algpseudocode: role globally in the package documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents: 144
diff changeset
7 This package contains `Pygments`_ lexers for some basic pseudocode.
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
8
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
9 Initially a fork of `pygments-lexer-pseudocode` it has been considerably
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
10 changed and expanded.
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
12 It now contains the following lexers:
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
13
141
acd9073cbbe3 Make a lexerlist.rst that contains the table of the lexers because it is used at least twice
Franz Glasner <fzglas.hg@dom66.de>
parents: 138
diff changeset
14 .. include:: lexerlist.rst
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
15
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
16
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
17 Installation
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
18 ============
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
19
145
c4f6f5e771b0 Also define the :algpseudocode: role globally in the package documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents: 144
diff changeset
20 The lexers are available as a `Python`_ wheel package::
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21
8
5812e7f3bc13 Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents: 1
diff changeset
22 pip install pygments-lexer-pseudocode2
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
24 Alternatively, to build from the source code repository::
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25
8
5812e7f3bc13 Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents: 1
diff changeset
26 python -m build
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
29 Usage
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
30 =====
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
32 After installation the Pseudocode lexers automatically register itself
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
33 within the plugin system of Pygments. All aliases and filename extensions
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
34 from above are made known to Pygments.
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
36 Usage is easy.
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
37
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
38 Pygmentizing a file with a known file extension::
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
40 pygmentize document.algpseudocode
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
42 Or you can manally select the Pseudocode lexer you want to use by
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
43 using a command line flag::
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
44
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
45 pygmentize -l algpseudocode somefile
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
144
b616f9645e37 More referencing with internal and external links
Franz Glasner <fzglas.hg@dom66.de>
parents: 141
diff changeset
47 Within `Sphinx`_ use a lexer like this::
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
48
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
49 .. code-block:: algpseudocode
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
51
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
52 License
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
53 =======
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54
136
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
55 The package is licensed under the terms of the MIT Licence.
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
56
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
57 Some code snippets are licensed under the terms of the
f713190c6c0b Also mention that some code snippets are licensed under the terms of BSD-2-Clause
Franz Glasner <fzglas.hg@dom66.de>
parents: 133
diff changeset
58 BSD 2-Clause "Simplified" License as they are taken from the Python
145
c4f6f5e771b0 Also define the :algpseudocode: role globally in the package documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents: 144
diff changeset
59 lexer that is included in `Pygments`_.