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

annotate README.rst @ 259:e9e605e837fc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More details in the changelog
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 17 May 2026 16:27:15 +0200
parents 265b759f1f08
children 3dce08f06ecc
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
167
ddefcc20367c More static and/or dynamic metadata into README and project's init: release date, revision.
Franz Glasner <fzglas.hg@dom66.de>
parents: 166
diff changeset
7 :Version: 3.0.0.dev1
ddefcc20367c More static and/or dynamic metadata into README and project's init: release date, revision.
Franz Glasner <fzglas.hg@dom66.de>
parents: 166
diff changeset
8 :Date: |VCSJustDate|
257
265b759f1f08 Add a license page to the documentation and drop a note about the licenses in the README
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
9 :Copyright:
265b759f1f08 Add a license page to the documentation and drop a note about the licenses in the README
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
10 - © 2026 Franz Glasner
265b759f1f08 Add a license page to the documentation and drop a note about the licenses in the README
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
11 - © 2015 Simon Wachter
265b759f1f08 Add a license page to the documentation and drop a note about the licenses in the README
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
12 :License: MIT License
167
ddefcc20367c More static and/or dynamic metadata into README and project's init: release date, revision.
Franz Glasner <fzglas.hg@dom66.de>
parents: 166
diff changeset
13 :Revision: |VCSRevision|
ddefcc20367c More static and/or dynamic metadata into README and project's init: release date, revision.
Franz Glasner <fzglas.hg@dom66.de>
parents: 166
diff changeset
14
184
5113d7fbae9e Optimize PDF content.
Franz Glasner <fzglas.hg@dom66.de>
parents: 179
diff changeset
15
195
959ed927b5fa Wording in docs
Franz Glasner <fzglas.hg@dom66.de>
parents: 184
diff changeset
16 This package contains `Pygments`_ lexers for some variants of pseudocode.
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
17
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
18 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
19 changed and expanded.
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
21 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
22
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
23 .. 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
24
166
6a7dace0141e Also implement filters to replace tokens in a token stream: TokenReplaceFilter and ErrorToGenericErrorTokenFilter
Franz Glasner <fzglas.hg@dom66.de>
parents: 145
diff changeset
25 It additionally contains the following filters:
6a7dace0141e Also implement filters to replace tokens in a token stream: TokenReplaceFilter and ErrorToGenericErrorTokenFilter
Franz Glasner <fzglas.hg@dom66.de>
parents: 145
diff changeset
26
6a7dace0141e Also implement filters to replace tokens in a token stream: TokenReplaceFilter and ErrorToGenericErrorTokenFilter
Franz Glasner <fzglas.hg@dom66.de>
parents: 145
diff changeset
27 .. include:: filterlist.rst
6a7dace0141e Also implement filters to replace tokens in a token stream: TokenReplaceFilter and ErrorToGenericErrorTokenFilter
Franz Glasner <fzglas.hg@dom66.de>
parents: 145
diff changeset
28
184
5113d7fbae9e Optimize PDF content.
Franz Glasner <fzglas.hg@dom66.de>
parents: 179
diff changeset
29 .. content-pdf
5113d7fbae9e Optimize PDF content.
Franz Glasner <fzglas.hg@dom66.de>
parents: 179
diff changeset
30
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
31
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
32 Installation
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
33 ============
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
34
145
c4f6f5e771b0 Also define the :algpseudocode: role globally in the package documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents: 144
diff changeset
35 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
36
8
5812e7f3bc13 Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents: 1
diff changeset
37 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
38
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
39 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
40
8
5812e7f3bc13 Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents: 1
diff changeset
41 python -m build
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
44 Usage
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
45 =====
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
179
94384bbcf1aa FIX: Wording in README: filters are registered automatically also
Franz Glasner <fzglas.hg@dom66.de>
parents: 167
diff changeset
47 After installation all the Pseudocode lexers and filters automatically
94384bbcf1aa FIX: Wording in README: filters are registered automatically also
Franz Glasner <fzglas.hg@dom66.de>
parents: 167
diff changeset
48 register itself within the plugin system of Pygments.
94384bbcf1aa FIX: Wording in README: filters are registered automatically also
Franz Glasner <fzglas.hg@dom66.de>
parents: 167
diff changeset
49 Their respective aliases and filename extensions 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
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 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
52
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
53 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
54
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
55 pygmentize document.algpseudocode
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56
198
Franz Glasner <fzglas.hg@dom66.de>
parents: 195
diff changeset
57 Or you can manually select the Pseudocode lexer you want to use by
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
58 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
59
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
60 pygmentize -l algpseudocode somefile
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61
144
b616f9645e37 More referencing with internal and external links
Franz Glasner <fzglas.hg@dom66.de>
parents: 141
diff changeset
62 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
63
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
64 .. code-block:: algpseudocode
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65
120
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
66
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
67 License
ef68b3769be5 Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents: 8
diff changeset
68 =======
1
4615d6df8293 ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69
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
70 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
71
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
72 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
73 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
74 lexer that is included in `Pygments`_.