Set of Pandoc filters to aid in literate programming
Project description
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
entangled-filters-0.4.tar.gz
(6.7 kB
view hashes)
