Exploratory programming environment and documentation generator
40ants-doc provides a rudimentary explorable programming environment. The narrative primarily lives in so-called sections that mix Markdown docstrings with references to functions, variables, etc., all of which should probably have their own docstrings.
The primary focus is on making code easily explorable by using SLIME's M-. (
slime-edit-definition). Generating documentation in Markdown or HTML format from sections and all the referenced items is also implemented.
With the simplistic tools provided, one may obtain results similar to literate programming, but documentation is generated from code, not the other way around, and there is no support for chunking. Code comes first, code must look pretty, documentation is code.
40ants-doc is a fork of MGL-PAX with fewer dependencies (only
pythonic-string-reader) for the core system, and additional features in the full system.
- Website: https://40ants.com/doc/
- Licenses: Expat
- Package source: gnu/packages/lisp-xyz.scm
- Builds: See build status
- Issues: See known issues
sbcl-40ants-doc 0.1.0-0.7725ff6 as follows:
guix install firstname.lastname@example.org
Or install the latest version:
guix install sbcl-40ants-doc
You can also install packages in augmented, pure or containerized environments for development or simply to try them out without polluting your user profile. See the
guix shell documentation for more information.