This package browser is in early development. Mind the rough edges.

cl-mgl-pax

Exploratory programming environment and documentation generator

PAX provides an extremely poor man's Explorable Programming environment. 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). See how to enable some fanciness in Emacs Integration. Generating documentation from sections and all the referenced items in Markdown or HTML format is also implemented.

With the simplistic tools provided, one may accomplish similar effects as with Literate Programming, but documentation is generated from code, not vice versa and there is no support for chunking yet. Code is first, code must look pretty, documentation is code.

Installation

Install the latest version of cl-mgl-pax as follows:

guix install cl-mgl-pax

Or install a particular version:

guix install cl-mgl-pax@0.3.0-1.6782eb0

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.

Badge code

You can use the following badge to inform users of cl-mgl-pax about the latest version available in Guix.

Example HTML:

<a href='https://packages.guix.gnu.org/packages/cl-mgl-pax'><img src='https://packages.guix.gnu.org/packages/cl-mgl-pax/badges/latest-version.svg' alt='Version in GNU Guix'></a>

Example Markdown:

[![Version in GNU Guix](https://packages.guix.gnu.org/packages/cl-mgl-pax/badges/latest-version.svg)](https://packages.guix.gnu.org/packages/cl-mgl-pax)

Example Org:

[[https://packages.guix.gnu.org/packages/cl-mgl-pax][https://packages.guix.gnu.org/packages/cl-mgl-pax/badges/latest-version.svg]]