forked from lijiext/lammps
e58791e29d | ||
---|---|---|
.. | ||
html | ||
src | ||
utils | ||
Developer.pdf | ||
Makefile | ||
Manual.pdf | ||
README.md | ||
lammps.book |
README.md
Generation of LAMMPS Documentation
The generation of all the documentation is managed by the Makefile inside the
doc/
folder.
Usage:
make html # generate HTML using Sphinx
make pdf # generate PDF using htmldoc
make clean # remove generated RST files
make clean-all # remove entire build folder and any cached data
Installing prerequisites
To run the documention build toolchain Python 3 and virtualenv have to be installed. The following are instructions for common Linux distributions:
virtualenv
Ubuntu
sudo apt-get install python-virtualenv
Fedora
sudo yum install python-virtualenv