Skip to main content

Set of Pandoc filters to aid in literate programming

Project description

Test Badge codecov

Entangled - Pandoc filters

This contains several Pandoc filters and scripts for literate programming in Markdown. These filters are enough to get you going with literate programming.

Install

pip install .

Testing

pip install -e .[test]
pytest

Supported syntax

See the project homepage for more info.

Named code blocks

``` {.python #hello}
print("Hello, World!")
```

Reference code blocks

``` {.python #main}
def main():
    <<hello>>
```

Define files

``` {.python file=hello.py}
<<main>>

if __name__ == "__main__":
    main()
```

Documentation tests

``` {.python .doctest #the-question}
6*7
---
42
```

pandoc-tangle

Extracts code blocks and writes them to files.

pandoc -t plain --filter pandoc-tangle hello.md

pandoc-test

Runs doctests, and include results into output.

pandoc -t html5 -s --filter pandoc-test hello.md

Release history Release notifications

This version

0.4

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for entangled-filters, version 0.4
Filename, size File type Python version Upload date Hashes
Filename, size entangled-filters-0.4.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page