cl-documentation-utils-extensions
Set of extensions for documentation-utils
Use rich-formatter
to format documentation with sections :syntax
, :arguments
, :examples
, :description
, :returns
, :side-effects
, :thread-safety
, :affected-by
, :see-also
and :notes
. Gather unformatted input by using rich-aggregating-formatter
and *DOCUMENTATION*
variable. Find gathered documentation with find-documentation function. Execute code stored in documentation with execute-documentation
. See the examples in the src/documentation.lisp
file. See the documentation-utils
system for more information.
- Versions: 0.0.0-1.f67f8a0
- Website: https://github.com/sirherrbatka/documentation-utils-extensions
- Licenses: Expat
- Package source: gnu/packages/lisp-xyz.scm
- Builds: See build status
- Issues: See known issues
Installation
Install the latest version of cl-documentation-utils-extensions
as follows:
guix install cl-documentation-utils-extensions
Or install a particular version:
guix install cl-documentation-utils-extensions@0.0.0-1.f67f8a0
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-documentation-utils-extensions about the latest version available in Guix.
Example HTML:
<a href='https://packages.guix.gnu.org/packages/cl-documentation-utils-extensions'><img src='https://packages.guix.gnu.org/packages/cl-documentation-utils-extensions/badges/latest-version.svg' alt='Version in GNU Guix'></a>
Example Markdown:
[](https://packages.guix.gnu.org/packages/cl-documentation-utils-extensions)
Example Org:
[[https://packages.guix.gnu.org/packages/cl-documentation-utils-extensions][https://packages.guix.gnu.org/packages/cl-documentation-utils-extensions/badges/latest-version.svg]]