SimpleDoc -- simpler documentation for functions and methods

Authors

Dan Grayson <dan@math.uiuc.edu>
Mike Stillman <mike@math.cornell.edu>

Version

This documentation describes version 1.1 of SimpleDoc.

Source code

The source code from which this documentation is derived is in the file SimpleDoc.m2. The auxiliary files accompanying it are in the directory SimpleDoc/.

Exports

Functions and commands
- doc -- a simple documentation function
- multidoc -- a simple documentation function, allowing multiple documentation nodes
- packageTemplate -- a template for a package
- simpleDocFrob -- an example of a function to document
Other things
- docExample -- an example documentation node
- docTemplate -- a template for a documentation node

SimpleDoc -- simpler documentation for functions and methods

Authors

Version

Source code

Exports

Menu