Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2
annotate README.rst @ 299:11f4f4d2ec03 default tip
Update to latest Sphinx customizations
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sat, 06 Jun 2026 12:12:06 +0200 |
| parents | 152dd8194f3b |
| children |
| 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 |
| 295 | 7 :Version: 3.0 |
| 8 :Date: 2026-05-23 | |
|
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 | 15 |
| 195 | 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 | 29 .. content-pdf |
| 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 |
| 273 | 35 The lexers and filters 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 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
37 .. code-block:: shell |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
38 |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
39 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
|
40 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
41 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
|
42 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
43 .. code-block:: shell |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
44 |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
45 python -m build |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
46 |
|
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
47 |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
48 Usage |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
49 ===== |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
50 |
|
179
94384bbcf1aa
FIX: Wording in README: filters are registered automatically also
Franz Glasner <fzglas.hg@dom66.de>
parents:
167
diff
changeset
|
51 After installation all the Pseudocode lexers and filters automatically |
| 271 | 52 register itself with the plugin system of Pygments. |
|
179
94384bbcf1aa
FIX: Wording in README: filters are registered automatically also
Franz Glasner <fzglas.hg@dom66.de>
parents:
167
diff
changeset
|
53 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
|
54 |
| 271 | 55 Usage is easy: |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
56 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
57 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
|
58 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
59 .. code-block:: shell |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
60 |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
61 pygmentize document.algpseudocode |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
62 |
| 198 | 63 Or you can manually select the Pseudocode lexer you want to use by |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
64 using a command line flag: |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
65 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
66 .. code-block:: shell |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
67 |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
68 pygmentize -l algpseudocode somefile |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
69 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
70 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
|
71 |
|
272
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
72 .. code-block:: none |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
73 |
|
9afbc584a444
Semantic markup and style in the README
Franz Glasner <fzglas.hg@dom66.de>
parents:
271
diff
changeset
|
74 .. code-block:: algpseudocode |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
75 |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
76 |
|
264
3dce08f06ecc
Wording in README: "License" -> "Licenses"
Franz Glasner <fzglas.hg@dom66.de>
parents:
257
diff
changeset
|
77 Licenses |
|
3dce08f06ecc
Wording in README: "License" -> "Licenses"
Franz Glasner <fzglas.hg@dom66.de>
parents:
257
diff
changeset
|
78 ======== |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
79 |
|
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
|
80 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
|
81 |
|
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
|
82 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
|
83 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
|
84 lexer that is included in `Pygments`_. |