How to generate the documentation¶
Requirements¶
Generate a PDF document¶
cd <mcsas>/doc
make latexpdf
The resulting McSAS.pdf
can be found in <mcsas>/doc/_build/latex/
.
Generate HTML pages¶
cd <mcsas>/doc
make html
The entry point index.html
can be found in <mcsas>/doc/_build/html/
.
Update Source Code Documentation¶
cd <mcsas>/doc
make clean
make apidoc
This command automatically generates sphinx documentation files for all source code files in the directory. It assumes the current working directory is the McSAS root directory.