History

sjplimp 8fa54096d3 git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15069 f3b2605a-c512-4ea7-a41b-209d697bcdaa		2016-05-31 14:48:46 +00:00
..
html	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15059 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-13 15:48:05 +00:00
src	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15069 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-31 14:48:46 +00:00
utils	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@14981 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-10 14:05:06 +00:00
Developer.pdf	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@14950 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-09 17:22:38 +00:00
Makefile	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15041 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-12 13:58:19 +00:00
Manual.pdf	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15061 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-17 17:02:58 +00:00
README.md	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@14950 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-09 17:22:38 +00:00
lammps.book	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15043 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-05-12 14:14:39 +00:00

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