Generating docs

From Powers Wiki
Revision as of 23:00, 3 June 2021 by Chris (talk | contribs)

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.



Making the pdf

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

> bin/doc


Section 2