ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

replace "doc page" with "page" or equivalent

Browse Source
This commit is contained in:
Axel Kohlmeyer
2020-10-07 22:29:26 -04:00
parent e683585bba
commit 60864f021f
7 changed files with 27 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Makefile
View File

@ -65,7 +65,7 @@ DOXYFILES = $(shell sed -n -e 's/\#.*$$//' -e '/^ *INPUT \+=/,/^[A-Z_]\+ \+
help: help:
@if [ "$(HAS_BASH)" == "NO" ] ; then echo "bash was not found at $(OSHELL)! Please use: $(MAKE) SHELL=/path/to/bash" 1>&2; exit 1; fi @if [ "$(HAS_BASH)" == "NO" ] ; then echo "bash was not found at $(OSHELL)! Please use: $(MAKE) SHELL=/path/to/bash" 1>&2; exit 1; fi
@echo "Please use \`make <target>' where <target> is one of" @echo "Please use \`make <target>' where <target> is one of"
@echo " html create HTML doc pages in html dir" @echo " html create HTML pages in html dir"
@echo " pdf create Manual.pdf in this dir" @echo " pdf create Manual.pdf in this dir"
@echo " fetch fetch HTML and PDF files from LAMMPS web site" @echo " fetch fetch HTML and PDF files from LAMMPS web site"
@echo " epub create ePUB format manual for e-book readers" @echo " epub create ePUB format manual for e-book readers"

25
doc/src/Build_basics.rst
View File

@ -134,8 +134,8 @@ support included as well. These are commands in the ``MPIIO``,
``SNAP``, ``USER-DIFFRACTION``, and ``USER-DPD`` packages. In addition ``SNAP``, ``USER-DIFFRACTION``, and ``USER-DPD`` packages. In addition
some packages support OpenMP threading indirectly through the libraries some packages support OpenMP threading indirectly through the libraries
they interface to: e.g. ``LATTE``, ``KSPACE``, and ``USER-COLVARS``. they interface to: e.g. ``LATTE``, ``KSPACE``, and ``USER-COLVARS``.
See the :doc:`Packages details <Packages_details>` doc page for more See the :doc:`Packages details <Packages_details>` page for more
info on these packages and the doc pages for their respective commands info on these packages and the pages for their respective commands
for OpenMP threading info. for OpenMP threading info.
For CMake, if you use ``BUILD_OMP=yes``, you can use these packages For CMake, if you use ``BUILD_OMP=yes``, you can use these packages
@ -310,7 +310,7 @@ LAMMPS.
required or recommended to enable required features and to required or recommended to enable required features and to
achieve optimal performance. You need to include these in the achieve optimal performance. You need to include these in the
CCFLAGS and LINKFLAGS settings above. For details, see the CCFLAGS and LINKFLAGS settings above. For details, see the
individual package doc pages listed on the documentation for the individual packages listed on the
:doc:`Speed_packages` page. Or examine these files in the :doc:`Speed_packages` page. Or examine these files in the
src/MAKE/OPTIONS directory. They correspond to each of the 5 src/MAKE/OPTIONS directory. They correspond to each of the 5
accelerator packages and their hardware variants: accelerator packages and their hardware variants:
@ -341,7 +341,7 @@ will then process commands provided via a file or from the console
input. The LAMMPS library can also be called from another application input. The LAMMPS library can also be called from another application
or a scripting language. See the :doc:`Howto couple <Howto_couple>` doc or a scripting language. See the :doc:`Howto couple <Howto_couple>` doc
page for more info on coupling LAMMPS to other codes. See the page for more info on coupling LAMMPS to other codes. See the
:doc:`Python <Python_head>` doc page for more info on wrapping and :doc:`Python <Python_head>` page for more info on wrapping and
running LAMMPS from Python via its library interface. running LAMMPS from Python via its library interface.
.. tabs:: .. tabs::
@ -472,13 +472,14 @@ Build the LAMMPS documentation
---------------------------------------- ----------------------------------------
The LAMMPS manual is written in `reStructuredText <rst_>`_ format which The LAMMPS manual is written in `reStructuredText <rst_>`_ format which
can be translated to different output format using the `Sphinx <sphinx_>`_ can be translated to different output format using the `Sphinx
document generator tool. Currently the translation to HTML and PDF (via <sphinx_>`_ document generator tool. Currently the translation to HTML
LaTeX) are supported. For that to work a Python 3 interpreter and and PDF (via LaTeX) are supported. For that to work a Python 3
internet access is required. For the documentation build a python interpreter and internet access is required. For the documentation
based virtual environment is set up in the folder doc/docenv and various build a python based virtual environment is set up in the folder
python packages are installed into that virtual environment via the pip ``doc/docenv`` and various python packages are installed into that
tool. The actual translation is then done via make commands. virtual environment via the ``pip`` tool. The actual translation is
then done via ``make`` commands.
.. _rst: https://docutils.readthedocs.io/en/sphinx-docs/user/rst/quickstart.html .. _rst: https://docutils.readthedocs.io/en/sphinx-docs/user/rst/quickstart.html
.. _sphinx: https://www.sphinx-doc.org .. _sphinx: https://www.sphinx-doc.org
@ -491,7 +492,7 @@ LAMMPS source distribution.
.. code-block:: bash .. code-block:: bash
make html # create HTML doc pages in html directory make html # create HTML pages in html directory
make pdf # create Manual.pdf in this directory make pdf # create Manual.pdf in this directory
make fetch # fetch HTML and PDF files from LAMMPS web site make fetch # fetch HTML and PDF files from LAMMPS web site
make clean # remove all intermediate files make clean # remove all intermediate files

2
doc/src/Install_git.rst
View File

@ -94,7 +94,7 @@ changed. To do this, you should cd to the src directory and type:
$ make package-update # sync package files with src files $ make package-update # sync package files with src files
$ make foo # re-build for your machine (mpi, serial, etc) $ make foo # re-build for your machine (mpi, serial, etc)
just as described on the :doc:`Apply patch <Install_patch>` doc page, just as described on the :doc:`Apply patch <Install_patch>` page,
after a patch has been installed. after a patch has been installed.
.. warning:: .. warning::

2
doc/src/Install_tarball.rst
View File

@ -61,4 +61,4 @@ periodically.)
The patch files are posted on the `bug and feature page <bug_>`_ of the The patch files are posted on the `bug and feature page <bug_>`_ of the
website, along with a list of changed files and details about what is website, along with a list of changed files and details about what is
in the new patch release. Instructions for applying a patch file are in the new patch release. Instructions for applying a patch file are
on the :doc:`Install patch <Install_patch>` doc page. on the :doc:`Install patch <Install_patch>` page.

7
doc/src/Manual.rst
View File

@ -21,7 +21,7 @@ all LAMMPS development is coordinated.
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 :doc:`Manual build <Manual_build>` doc page. following the steps on the :doc:`Manual build <Manual_build>` page.
The manual is organized in two parts: The manual is organized in two parts:
1) the :ref:`User documentation <user_documentation>` for how to install 1) the :ref:`User documentation <user_documentation>` for how to install
and use LAMMPS and 2) the :ref:`Programmer documentation <programmer_documentation>` and use LAMMPS and 2) the :ref:`Programmer documentation <programmer_documentation>`
@ -30,8 +30,9 @@ programming languages and how to modify and extend LAMMPS.
.. only:: html .. only:: html
Once you are familiar with LAMMPS, you may want to bookmark :doc:`this page <Commands_all>` since it gives quick access to a doc page for Once you are familiar with LAMMPS, you may want to bookmark
every LAMMPS command. :doc:`this page <Commands_all>` since it gives quick access
the documentation for all LAMMPS commands.
.. _lws: https://lammps.sandia.gov .. _lws: https://lammps.sandia.gov

10
doc/src/Manual_build.rst
View File

@ -32,8 +32,8 @@ and PDF files are not included. Instead you need to create them, in one
of two ways: of two ways:
a. You can "fetch" the current HTML and PDF files from the LAMMPS web a. You can "fetch" the current HTML and PDF files from the LAMMPS web
site. Just type ``make fetch``. This should download a html_www site. Just type ``make fetch``. This should download a ``html_www``
directory and a Manual_www.pdf file. Note that if new LAMMPS features directory and a ``Manual_www.pdf`` file. Note that if new LAMMPS features
have been added more recently than the date of your LAMMPS version, the have been added more recently than the date of your LAMMPS version, the
fetched documentation will include those changes (but your source code fetched documentation will include those changes (but your source code
will not, unless you update your local repository). will not, unless you update your local repository).
@ -54,15 +54,15 @@ A version of the manual corresponding to the ongoing development
---------- ----------
The generation of all documentation is managed by the Makefile in the The generation of all documentation is managed by the Makefile in the
doc directory. The following documentation related make commands are doc directory. The following documentation related ``make`` commands are
available: available:
.. code-block:: bash .. code-block:: bash
make html # generate HTML in html dir using Sphinx make html # generate HTML in html dir using Sphinx
make pdf # generate PDF as Manual.pdf using Sphinx and pdflatex make pdf # generate PDF as Manual.pdf using Sphinx and pdflatex
make fetch # fetch HTML doc pages and PDF file from web site make fetch # fetch HTML pages and PDF files from LAMMPS web site
# as a tarball and unpack into html dir and PDF # and unpack into the html_www folder and Manual_www.pdf
make epub # generate LAMMPS.epub in ePUB format using Sphinx make epub # generate LAMMPS.epub in ePUB format using Sphinx
make mobi # generate LAMMPS.mobi in MOBI format using ebook-convert make mobi # generate LAMMPS.mobi in MOBI format using ebook-convert

4
doc/src/Manual_version.rst
View File

@ -17,7 +17,7 @@ run LAMMPS. It is also in the file src/version.h and in the LAMMPS
directory name created when you unpack a tarball. And it is on the directory name created when you unpack a tarball. And it is on the
first page of the :doc:`manual <Manual>`. first page of the :doc:`manual <Manual>`.
* If you browse the HTML doc pages on the LAMMPS WWW site, they always * If you browse the HTML pages on the LAMMPS WWW site, they always
describe the most current patch release of LAMMPS. describe the most current patch release of LAMMPS.
* If you browse the HTML doc pages included in your tarball, they * If you browse the HTML pages included in your tarball, they
describe the version you have, which may be older. describe the version you have, which may be older.