Generating docs

MVAPACK's uses GNU Texinfo for documentation. The end goal is to generate a .pdf file that contains all of the information for each function as well as general usage, pipelines and examples. This guide is NOT designed to cover all the details of writing GNU Texinfo and its syntax, but just how the documentation for this project works and how to build new pdf's for future releases.

In general there are two parts to documentation source, being the Texinfo found in each of the files contained within mvapack/inst/ and the main file found in mvapack/doc/mvapack.tex . This page covers how to change these types of Texinfo entries as well as making the .pdf itself.

Making the pdf

To make the documentation, first cd into your mvapack/ directory. Next, you will run the following command:

> bin/doc

• This will build the documentation and save it to mvapack/doc/mvapack.pdf , assuming the build finished successfully.