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

add ability to build an offline viewable html format manual in html-offline

Browse Source
This commit is contained in:
Axel Kohlmeyer
2020-02-22 02:27:18 -05:00
parent 59ed320bef
commit 60cb4416f0
3 changed files with 66 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/src/Manual_build.rst
View File

@ -9,6 +9,7 @@ sub-directories and optionally 2 PDF files and 2 e-book format files:
src # content files for LAMMPS documentation
html # HTML version of the LAMMPS manual (see html/Manual.html)
html-offline # Offline viewable 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
@ -31,12 +32,20 @@ a. You can "fetch" the current HTML and PDF files from the LAMMPS web
repository).
b. You can build the HTML and PDF files yourself, by typing "make html"
followed by "make pdf". This requires various tools including
Sphinx, which the build process will attempt to download and install
automatically into a virtual environment in the folder doc/docenv, if
not already available. See more details below. To generate the PDF
version of the manual, additionally the PDFLaTeX software and several
LaTeX packages are required.
or "make html-offline" followed by "make pdf". This requires various
tools including Sphinx, which the build process will attempt to
download and install automatically into a virtual environment in the
folder doc/docenv, if not already available. This download is
required only once. The default HTML version in the html folder
requires internet access to view the embedded math expressions. To
be able to view the math offline, some extra data and javascript code
needs to be downloaded and the HTML generation needs to be changed to
reference them. When typing "make html-offline" this is done
automatically. Same as for the sphinx tool, this download is
required only once. After that also the processing of the
documentation can be done without internet access. To generate the
PDF version of the manual, additionally the PDFLaTeX software and
several LaTeX packages are required.
----------
@ -50,6 +59,7 @@ the doc directory.
Documentation Build Options:
make html # generate HTML in html dir using Sphinx
make html-offline # generate offline viewable HTML in html-offline dir using Sphinx
make pdf # generate 2 PDF files (Manual.pdf,Developer.pdf)
# in doc dir via htmldoc and pdflatex
make fetch # fetch HTML doc pages and 2 PDF files from web site