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

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

Documentation helpers

Contributors

Andrew Hoefel contributed to this package.

Authors

Version

This documentation describes version 1.2 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
    • 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

For the programmer

The object SimpleDoc is a package.