From fb64ae612f94f45dad242d8e4ce1498376fe488a Mon Sep 17 00:00:00 2001 From: sjplimp Date: Mon, 26 Sep 2016 16:23:53 +0000 Subject: [PATCH] git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@15645 f3b2605a-c512-4ea7-a41b-209d697bcdaa --- doc/README | 49 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git a/doc/README b/doc/README index 686a1802a4..fa40e35910 100644 --- a/doc/README +++ b/doc/README @@ -1,10 +1,46 @@ -Generation of LAMMPS Documentation +LAMMPS Documentation + +Depending on how you obtained LAMMPS, this directory has 2 or 3 +sub-directories and optionally 2 PDF files: + +src content files for LAMMPS documentation +html HTML version of the LAMMPS manual (see html/Manual.html) +tools tools and settings for building the documentation +Manual.pdf large PDF version of entire manual +Developer.pdf small PDF with info about how LAMMPS is structured + +If you downloaded LAMMPS as a tarball from the web site, all these +directories and files should be included. + +If you downloaded LAMMPS from the public SVN or Git repositories, then +the HTML and PDF files are not included. Instead you need to create +them, in one of three ways: + +(a) You can "fetch" the current HTML and PDF files from the LAMMPS web +site. Just type "make fetch". This should create a html_www dir and +Manual_www.pdf/Developer_www.pdf files. Note that if new LAMMPS +features have been added more recently than the date of your version, +the fetched documentation will include those changes (but your source +code will not, unless you update your local repository). + +(b) You can build the HTML and PDF files yourself, by typing "make +html" followed by "make pdf". Note that the PDF make requires the +HTML files already exist. This requires various tools including +Sphinx, which the build process will attempt to download and install +on your system, if not already available. See more details below. + +(c) You can genererate an older, simpler, less-fancy style of HTML +documentation by typing "make old". This will create an "old" +directory. This can be useful if (b) does not work on your box for +some reason, or you want to quickly view the HTML version of a doc +page you have created or edited yourself within the src directory. +E.g. if you are planning to submit a new feature to LAMMPS. + +---------------- The generation of all documentation is managed by the Makefile in this dir. ----------------- - Options: make html # generate HTML in html dir using Sphinx @@ -51,3 +87,10 @@ Once Python 3 is installed, open a Terminal and type pip3 install virtualenv This will install virtualenv from the Python Package Index. + +---------------- + +Installing prerequisites for PDF build + + +