History

Steve Plimpton 6c65af710c bad file?		2016-08-31 16:10:20 -06:00
..
html	bad file?	2016-08-31 16:10:20 -06:00
src	sync with SVN	2016-08-31 15:17:00 -06:00
utils	Remove sha1sum dependency for doc generation	2016-08-26 00:01:34 -04:00
.gitignore	new fix flow/gauss command	2016-08-27 16:25:01 -06: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	Remove sha1sum dependency for doc generation	2016-08-26 00:01:34 -04: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	updated doc build readme for current Fedora and RHEL/CentOS	2016-08-28 14:20:23 -04: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. Here are instructions for common setups:

Ubuntu

sudo apt-get install python-virtualenv

Fedora (up to version 21), Red Hat Enterprise Linux or CentOS (up to version 7.x)

sudo yum install python3-virtualenv

Fedora (since version 22)

sudo dnf install python3-virtualenv

MacOS X

Python 3

Download the latest Python 3 MacOS X package from https://www.python.org and install it. This will install both Python 3 and pip3.

virtualenv

Once Python 3 is installed, open a Terminal and type pip3 install virtualenv. This will install virtualenv from the Python Package Index.