Support and Documentation

Online documentation

See AMC-ItemAnalysis at RTD.io for online documentation.

Documentation is built by Sphinx and continuously integrated from the GitHub repository.

Locally-installed documentation

After installing, you can find documentation for the modules with the perldoc command. You just have to look in the right place. You can either add the plugin directory to perl’s library path and search for the modules by their perl names,

PERL5LIB=~/.AMC.d/plugins/ItemAnalysis/perl/ perldoc AMC::ItemAnalysis

or navigate straight to the .pm files.

perldoc ~/.AMC.d/plugins/ItemAnalysis/perl/AMC/ItemAnalysis.pm

Building documentation from source

The module also supports the Sphinx docmentation system (requires Python; see reqirements-doc.txt). The librst build action will create reST files from the module’s POD documentation, and then the Sphinx documentation can be built.

./Build librst
cd doc/ && make html
open _build/html/index.html

Support

If you have a question, bug report, or feature request, please open an issue on the AMC-ItemAnalysis Github page.