Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2
annotate README.rst @ 255:fac80ec8e752
FIX: Need to manipulate tocdepth to also suppress ToC entries for sections without numbers
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sun, 17 May 2026 13:06:50 +0200 |
| parents | 6aa1d89cd869 |
| children | 265b759f1f08 |
| 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| |
|
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
|
9 :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
|
10 :License: MIT License |
|
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
|
11 |
| 184 | 12 |
| 195 | 13 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
|
14 |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
15 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
|
16 changed and expanded. |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
17 |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
18 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
|
19 |
|
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
|
20 .. 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
|
21 |
|
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
|
22 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
|
23 |
|
6a7dace0141e
Also implement filters to replace tokens in a token stream: TokenReplaceFilter and ErrorToGenericErrorTokenFilter
Franz Glasner <fzglas.hg@dom66.de>
parents:
145
diff
changeset
|
24 .. 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
|
25 |
| 184 | 26 .. content-pdf |
| 27 | |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
28 |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
29 Installation |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
30 ============ |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
31 |
|
145
c4f6f5e771b0
Also define the :algpseudocode: role globally in the package documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents:
144
diff
changeset
|
32 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
|
33 |
|
8
5812e7f3bc13
Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents:
1
diff
changeset
|
34 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
|
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 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
|
37 |
|
8
5812e7f3bc13
Rename the project the implementing class to "pygments-lexer-pseudocode2".
Franz Glasner <fzglas.hg@dom66.de>
parents:
1
diff
changeset
|
38 python -m build |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
39 |
|
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
40 |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
41 Usage |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
42 ===== |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
43 |
|
179
94384bbcf1aa
FIX: Wording in README: filters are registered automatically also
Franz Glasner <fzglas.hg@dom66.de>
parents:
167
diff
changeset
|
44 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
|
45 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
|
46 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
|
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 is easy. |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
49 |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
50 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
|
51 |
|
120
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
52 pygmentize document.algpseudocode |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
53 |
| 198 | 54 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
|
55 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
|
56 |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
57 pygmentize -l algpseudocode somefile |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
58 |
|
144
b616f9645e37
More referencing with internal and external links
Franz Glasner <fzglas.hg@dom66.de>
parents:
141
diff
changeset
|
59 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
|
60 |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
61 .. code-block:: algpseudocode |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
62 |
|
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 License |
|
ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
Franz Glasner <fzglas.hg@dom66.de>
parents:
8
diff
changeset
|
65 ======= |
|
1
4615d6df8293
ADD: The original pygments-lexer-pseudocode project from GitHub.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff
changeset
|
66 |
|
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
|
67 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
|
68 |
|
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
|
69 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
|
70 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
|
71 lexer that is included in `Pygments`_. |