some small tweaks, fixes for typos, and url corrections for the manual
This commit is contained in:
1
doc/.gitignore
vendored
1
doc/.gitignore
vendored
@ -1,5 +1,6 @@
|
|||||||
/latex
|
/latex
|
||||||
/html
|
/html
|
||||||
|
/latex
|
||||||
/spelling
|
/spelling
|
||||||
/LAMMPS.epub
|
/LAMMPS.epub
|
||||||
/LAMMPS.mobi
|
/LAMMPS.mobi
|
||||||
|
|||||||
@ -12,7 +12,7 @@ Download an executable for Windows :h3
|
|||||||
Pre-compiled Windows installers which install LAMMPS executables on a
|
Pre-compiled Windows installers which install LAMMPS executables on a
|
||||||
Windows system can be downloaded from this site:
|
Windows system can be downloaded from this site:
|
||||||
|
|
||||||
"http://rpm.lammps.org/windows.html"_http://rpm.lammps.org/windows.html
|
"http://packages.lammps.org/windows.html"_http://packages.lammps.org/windows.html
|
||||||
|
|
||||||
Note that each installer package has a date in its name, which
|
Note that each installer package has a date in its name, which
|
||||||
corresponds to the LAMMPS version of the same date. Installers for
|
corresponds to the LAMMPS version of the same date. Installers for
|
||||||
|
|||||||
@ -37,27 +37,21 @@ LAMMPS is an open-source code, distributed freely under the terms of
|
|||||||
the GNU Public License (GPL).
|
the GNU Public License (GPL).
|
||||||
|
|
||||||
The "LAMMPS website"_lws has a variety of information about the code.
|
The "LAMMPS website"_lws has a variety of information about the code.
|
||||||
It includes links to an on-line version of this manual, a "mail
|
It includes links to an on-line version of this manual, a "mailing
|
||||||
list"_http://lammps.sandia.gov/mail.html where users can post
|
list"_http://lammps.sandia.gov/mail.html where users can post
|
||||||
questions, and a "GitHub site"https://github.com/lammps/lammps where
|
questions, and a "GitHub site"_https://github.com/lammps/lammps where
|
||||||
all LAMMPS development is coordinated.
|
all LAMMPS development is coordinated.
|
||||||
|
|
||||||
:line
|
:line
|
||||||
|
|
||||||
"PDF file"_Manual.pdf of the entire manual, generated by
|
|
||||||
"htmldoc"_http://freecode.com/projects/htmldoc
|
|
||||||
|
|
||||||
The content for this manual is part of the LAMMPS distribution. You
|
The content for this manual is part of the LAMMPS distribution. You
|
||||||
can build a local copy of the Manual as HTML pages or a PDF file, by
|
can build a local copy of the Manual as HTML pages or a PDF file, by
|
||||||
following the steps on the "Manual build"_Manual_build.html doc page.
|
following the steps on the "Manual build"_Manual_build.html doc page.
|
||||||
|
|
||||||
There is also a "Developer.pdf"_Developer.pdf document which gives
|
There is also a "Developer.pdf"_Developer.pdf document which gives
|
||||||
a brief description of the basic code structure of LAMMPS.
|
a brief description of the basic code structure of LAMMPS.
|
||||||
|
|
||||||
:line
|
:line
|
||||||
|
|
||||||
This manual is organized into the following sections.
|
|
||||||
|
|
||||||
Once you are familiar with LAMMPS, you may want to bookmark "this
|
Once you are familiar with LAMMPS, you may want to bookmark "this
|
||||||
page"_Commands.html since it gives quick access to a doc page for
|
page"_Commands.html since it gives quick access to a doc page for
|
||||||
every LAMMPS command.
|
every LAMMPS command.
|
||||||
|
|||||||
@ -221,7 +221,7 @@ latex_elements = {
|
|||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('Manual', 'LAMMPS.tex', 'LAMMPS Documentation',
|
('Manual', 'LAMMPS.tex', 'LAMMPS Documentation',
|
||||||
'Steve Plimpton', 'manual'),
|
'The LAMMPS Developers', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
|
|||||||
Reference in New Issue
Block a user