Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2
changeset 120:ef68b3769be5
Convert/rename README.md to README.rst and enhance it considerably
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Wed, 06 May 2026 15:28:25 +0200 |
| parents | 9be446a43b81 |
| children | a3ed7d8231d7 |
| files | MANIFEST.in README.md README.rst docs/readme.rst pyproject.toml |
| diffstat | 5 files changed, 90 insertions(+), 35 deletions(-) [+] |
line wrap: on
line diff
--- a/MANIFEST.in Wed May 06 15:16:48 2026 +0200 +++ b/MANIFEST.in Wed May 06 15:28:25 2026 +0200 @@ -1,4 +1,4 @@ -include .hg* *.txt *.ini +include .hg* *.txt *.ini *.rst graft LICENSES graft docs graft tests
--- a/README.md Wed May 06 15:16:48 2026 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,31 +0,0 @@ -# (French) Pseudocode syntax lexer for Pygments - -This package contains a Pygments Lexer for some basic pseudocode algorithmics. - -## Installation - -The lexer is available as a Pip package: - - pip install pygments-lexer-pseudocode2 - -Alternatively, to install from the git repository: (you may need to sudo depending on your Python environment) - - python -m build - -## Usage - -After installation the Pseudocode lexer automatically registers itself for files with the `.algo` and `.pseudocode` extensions. Therefore, usage is easy: - - pygmentize document.algo - -You can also manally indicate you want to use the Pseudocode lexer by using a command line flag: - - pygmentize -l pseudocode somefile - -## Contribute - -If you found a bug, don't hesitate to make a pull request. - -## License - -The Pseudocode lexer is licensed under the terms of the MIT licence
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.rst Wed May 06 15:28:25 2026 +0200 @@ -0,0 +1,82 @@ +.. -*- coding: utf-8 -*- + +***************************************** + README -- Pseudocode Lexer for Pygments +***************************************** + +This package contains Pygments lexers for some basic pseudocode. + +Initially a fork of `pygments-lexer-pseudocode` it has been considerably +changed and expanded. + +It now contains the following lexers: + +.. list-table:: + :align: left + :header-rows: 1 + + * - Name + - Description + - Extension(s) + - Aliases / Short Name(s) + + * - AlgPseudocode + - Pseudocode with inspirations from CTAN's "Algpseudocodex" + - \*.algpseudocode, \*.algpseudo + - algpseudocode, algpseudo + + * - AlgPseudocodeFR + - AlgPseudocode with french keyword expansion + - \*.algpseudo-fr, \*.algpseudocode-fr + - algpseudocode-fr, algpseudo-fr + + * - AlgPseudocodeDE + - AlgPseudocode with german keyword expansion + - \*.algpseudo-de, \*.algpseudocode-de + - algpseudocode-de, algpseudo-de + + * - FrPseudocode + - The original lexer (slightly changed) from `pygments-lexer-pseudocode` + - \*.fr-algo, \*.fr-pseudocode + - fr-pseudocode, fr-pseudo, fr-algorithm, fr-algo + + +Installation +============ + +The lexers are available as a Python wheel package:: + + pip install pygments-lexer-pseudocode2 + +Alternatively, to build from the source code repository:: + + python -m build + + +Usage +===== + +After installation the Pseudocode lexers automatically register itself +within the plugin system of Pygments. All aliases and filename extensions +from above are made known to Pygments. + +Usage is easy. + + Pygmentizing a file with a known file extension:: + + pygmentize document.algpseudocode + + Or you can manally select the Pseudocode lexer you want to use by + using a command line flag:: + + pygmentize -l algpseudocode somefile + + Within Sphinx use a lexer like this:: + + .. code-block:: algpseudocode + + +License +======= + +The Pseudocode lexer is licensed under the terms of the MIT licence
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/readme.rst Wed May 06 15:28:25 2026 +0200 @@ -0,0 +1,4 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +.. include:: ../README.rst +
--- a/pyproject.toml Wed May 06 15:16:48 2026 +0200 +++ b/pyproject.toml Wed May 06 15:28:25 2026 +0200 @@ -4,11 +4,11 @@ [project] name = "pygments-lexer-pseudocode2" -description = "Pygments Lexer for a french pseudocode" +description = "Pygments Lexer for Pseudocode" license = { file = "LICENSES/MIT.txt" } authors = [ + {name = "Franz Glasner", email = "fzglas.hg@dom66.de"}, {name = "Simon Wachter", email = "simon@wachter.me"}, - {name = "Franz Glasner", email = "fzglas.hg@dom66.de"}, ] classifiers = [ "Development Status :: 4 - Beta", @@ -60,4 +60,4 @@ [tool.setuptools.dynamic] version = {attr = "pygments_lexer_pseudocode2.__version__"} -readme = {file = ["README.md"], content-type = "text/markdown"} +readme = {file = ["README.rst"], content-type = "text/x-rst"}
