next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
SimpleDoc :: SimpleDoc

SimpleDoc -- simpler documentation for functions and methods



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/.


  • 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