SimpleDoc -- simpler documentation for functions and methods

Description

This package provides a simple, human-readable text format for documentation nodes as an alternative to the classic hypertext list format accepted by the document(List) function.

The new format is accepted by the doc(String) function for writing either a single or multiple documentation nodes from a string or file and adheres to the off-side rule, i.e., using indentation to separate blocks.

Getting started with SimpleDoc

Templates for using the doc(String) method

docExample -- an example of a documentation string
docTemplate -- a simple documentation function
packageTemplate -- a template for a package

Documentation helpers

arXiv -- link to an arXiv article
stacksProject -- link to a Stacks Project tag
wikipedia -- link to a Wikipedia article

Contributors

Andrew Hoefel contributed to this package.

Authors

Version

This documentation describes version 1.3 of SimpleDoc.

Citation

If you have used this package in your research, please cite it as follows:

@misc{SimpleDocSource,
  title = {{SimpleDoc: a simple documentation function. Version~1.3}},
  author = {Daniel R. Grayson and Mike Stillman and Mahrud Sayrafi},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/master/M2/Macaulay2/packages}}
}

Exports

Functions and commands
- arXiv -- link to an arXiv article
- doc -- a simple documentation function
- multidoc -- see doc -- a simple documentation function
- packageTemplate -- a template for a package
- simpleDocFrob -- a sample documentation node
- stacksProject -- link to a Stacks Project tag
- wikipedia -- link to a Wikipedia article
Methods
- arXiv(String) -- see arXiv -- link to an arXiv article
- arXiv(String,String) -- see arXiv -- link to an arXiv article
- doc(String) -- see doc -- a simple documentation function
- packageTemplate(String) -- see packageTemplate -- a template for a package
- simpleDocFrob(ZZ,Matrix) -- see simpleDocFrob -- a sample documentation node
- stacksProject(String,String) -- see stacksProject -- link to a Stacks Project tag
- wikipedia(String) -- see wikipedia -- link to a Wikipedia article
- wikipedia(String,String) -- see wikipedia -- link to a Wikipedia article
Other things
- docExample -- an example of a documentation string
- docTemplate -- a simple documentation function
- testExample -- an example of a test string

For the programmer

The object SimpleDoc is a package, defined in SimpleDoc.m2, with auxiliary files in SimpleDoc/.

The source of this document is in SimpleDoc.m2:308:0.