History

Axel Kohlmeyer ff541e9a84 fix typo in compute omega/chunk usage example		2016-08-24 23:04:27 -04:00
..
html	doc files	2016-08-23 16:28:36 -06:00
src	fix typo in compute omega/chunk usage example	2016-08-24 23:04:27 -04:00
utils	git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15137 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-06-07 16:21:00 +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@15412 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-07-30 18:40:03 +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@15410 f3b2605a-c512-4ea7-a41b-209d697bcdaa	2016-07-30 16:09:11 +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