Repository files navigation

pandocode is a pandoc filter that converts Python(-like) code to LaTeX-Pseudocode.
It can also be used as a standalone program.

Outputs the resulting LaTeX code to console

Run:
./pandocode.pyz <file>
or
pandocode <file>

Converts every code-block of typepseudo to LaTeX

Run:
pandoc --filter /path/to/pandocode.pyz <infile.md> -o <outfile>
or
pandoc --filter pandocode <infile.md> -o <outfile>

• Install dependencies fromrequirements.txt andmake-requirements.txt
  • pip3 install -r requirements.txt -r make-requirements.txt
  • orpip3 install --user -r requirements.txt -r make-requirements.txt
• Runmake
• Optional: Runsudo make install
  • This will installpandocode.pyz to/usr/bin/pandocode

• Usepypy3 -m pip instead ofpip3
  • If pip is missing, install it withpypy3 -m ensurepip orpypy3 -m ensurepip --user
• Runmake PY=pypy3 instead ofmake

If you want to build without running pylint:

• Don't installmake-requirements.txt
• Runmake PYLINT=$(which true) instead ofmake

There is an example in the demo directory

Pandocode allows the use of the following control sequences inside the code:

Syntax:

• #$begin
• #$end

If a begin sequence is found, Pandocode ignores any code that is outside of a pair of begin/end control sequences.
If the end of the code is reached and no end sequence is encountered, all code from the begin sequence on is included.

Syntax:

• #$+ <text>

Includes<text> as a line in the code before code processing.

Syntax:

• #$-

Removes the next line before code processing.

Syntax:

• #$= <text>

Replaces the next line by<text> before code processing.

Syntax:

• :: <LaTeX>

When encountered during processing, instead of processing this line,:: gets removed and<LaTeX> is appended to the output.
This can be used as<text> in any control sequence that is processed before code processing.

Example:
#$= :: <LaTeX>
Replaces the next line by raw LaTeX

Pandocode is tested to be working withpandoc-include-code

---header-includes:  - \usepackage[noend]{algpseudocode}---```{.pseudo include=code.py}```