HACKER Q&A
📣 w4rh4wk5

Literate Programming Tool Recommendation


So, I am currently looking for a tool that allows me to do literate programming.

My goal is to create a pen and paper RPG, kinda like D&D, but simpler. I'd like to develop a Python module along with it which allows me to test and balance the mechanics of the game -- maybe even use it during play sessions to keep track of data. I want to try the literate programming approach here, writing down the rules of the game along with creating the module.

While I'll be using Python as programming language, I'd rather avoid anything notebook related. I just don't like the concept of notebooks and would rather create a typical module, that can also be viewed/rendered as HTML. Would be great if the tool is language agnostic though.

Markdown, AsciiDoc, or reStructuredText are okay. I know org-mode is a common recommendation, but I am not an Emacs guy and org-mode support isn't that great in other editors.

Typesetting equations using LaTeX syntax is a bonus, but certainly not required. LaTeX as output format is not required at all.


  👤 n3k5 Accepted Answer ✓
Depending on which style of literate programming you're going for, Sphinx[0] might be a good starting point. There are extensions that can fulfill a lot of requirements; for example, I like using Napoleon[1] and MyST-parser[2].

[0] https://www.sphinx-doc.org [1] https://www.sphinx-doc.org/en/master/usage/extensions/napole... [2] https://myst-parser.readthedocs.io/en/latest/sphinx/intro.ht...


👤 daly
Use latex.

I've re-created a 1.2 million line program as a literate program. https://en.wikipedia.org/wiki/Axiom_(computer_algebra_system...