Macaulay2 » Documentation
Packages » Macaulay2Doc » The Macaulay2 language » packages » makePackageIndex

next | previous | forward | backward | up | index | toc

makePackageIndex -- create an index of installed packages

Usage:

makePackageIndex()
Consequences:
- Creates a file index.html in the ~/.Macaulay2 directory, containing links to the documentation for Macaulay2 and all installed packages.

Description

This command may need to be run after installing a package via installPackage.

This command is run each time the program is started, updating the index file. Thus, one can simply restart Macaulay2 to obtain the same consequence.

See also

packages -- Macaulay2 packages

Ways to use makePackageIndex:

makePackageIndex(List)
makePackageIndex(Sequence)

For the programmer

The object makePackageIndex is a method function with a single argument.

The source of this document is in Macaulay2Doc/functions/package-doc.m2:688:0.