Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
L
lammps
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
multiscale
lammps
Commits
6742fb63
Commit
6742fb63
authored
8 years ago
by
Axel Kohlmeyer
Browse files
Options
Downloads
Patches
Plain Diff
remove mobi file format creation from makefile and explain it in README instead
parent
ed3f02f2
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/Makefile
+6
-6
6 additions, 6 deletions
doc/Makefile
doc/README
+9
-11
9 additions, 11 deletions
doc/README
with
15 additions
and
17 deletions
doc/Makefile
+
6
−
6
View file @
6742fb63
...
@@ -22,7 +22,7 @@ endif
...
@@ -22,7 +22,7 @@ endif
SOURCES
=
$(
wildcard src/
*
.txt
)
SOURCES
=
$(
wildcard src/
*
.txt
)
OBJECTS
=
$(
SOURCES:src/%.txt
=
$(
RSTDIR
)
/%.rst
)
OBJECTS
=
$(
SOURCES:src/%.txt
=
$(
RSTDIR
)
/%.rst
)
.PHONY
:
help clean-all clean e
book
html pdf old venv
.PHONY
:
help clean-all clean e
pub
html pdf old venv
# ------------------------------------------
# ------------------------------------------
...
@@ -32,7 +32,7 @@ help:
...
@@ -32,7 +32,7 @@ help:
@
echo
" pdf create Manual.pdf and Developer.pdf in this dir"
@
echo
" pdf create Manual.pdf and Developer.pdf in this dir"
@
echo
" old create old-style HTML doc pages in old dir"
@
echo
" old create old-style HTML doc pages in old dir"
@
echo
" fetch fetch HTML and PDF files from LAMMPS web site"
@
echo
" fetch fetch HTML and PDF files from LAMMPS web site"
@
echo
" e
book
create ePUB
/mobi file with manual in this dir
"
@
echo
" e
pub
create ePUB
format manual for e-book readers
"
@
echo
" clean remove all intermediate RST files"
@
echo
" clean remove all intermediate RST files"
@
echo
" clean-all reset the entire build environment"
@
echo
" clean-all reset the entire build environment"
@
echo
" txt2html build txt2html tool"
@
echo
" txt2html build txt2html tool"
...
@@ -64,8 +64,9 @@ html: $(OBJECTS)
...
@@ -64,8 +64,9 @@ html: $(OBJECTS)
@
rm
-rf
html/USER/
*
/
*
.[sg]
*
@
rm
-rf
html/USER/
*
/
*
.[sg]
*
@
echo
"Build finished. The HTML pages are in doc/html."
@
echo
"Build finished. The HTML pages are in doc/html."
e
book
:
$(OBJECTS)
e
pub
:
$(OBJECTS)
@
mkdir
-p
epub
@
mkdir
-p
epub
@
rm
-f
LAMMPS.epub
@
cp
src/JPG/lammps-logo.png epub/
@
cp
src/JPG/lammps-logo.png epub/
@
(
\
@
(
\
.
$(
VENV
)
/bin/activate
;
\
.
$(
VENV
)
/bin/activate
;
\
...
@@ -73,10 +74,9 @@ ebook: $(OBJECTS)
...
@@ -73,10 +74,9 @@ ebook: $(OBJECTS)
sphinx-build
-j
8
-b
epub
-c
utils/sphinx-config
-d
$(
BUILDDIR
)
/doctrees
$(
RSTDIR
)
epub
;
\
sphinx-build
-j
8
-b
epub
-c
utils/sphinx-config
-d
$(
BUILDDIR
)
/doctrees
$(
RSTDIR
)
epub
;
\
deactivate
;
\
deactivate
;
\
)
)
@
-
(
cd
epub
;
ebook-convert LAMMPS.epub LAMMPS.mobi
)
@
mv
epub/LAMMPS.epub .
@
-mv
-f
epub/LAMMPS.epub epub/LAMMPS.mobi .
@
rm
-rf
epub
@
rm
-rf
epub
@
echo
"Build finished. The e
book file(s) is/are
created."
@
echo
"Build finished. The e
PUB manual file is
created."
pdf
:
utils/txt2html/txt2html.exe
pdf
:
utils/txt2html/txt2html.exe
@
(
\
@
(
\
...
...
This diff is collapsed.
Click to expand it.
doc/README
+
9
−
11
View file @
6742fb63
LAMMPS Documentation
LAMMPS Documentation
Depending on how you obtained LAMMPS, this directory has 2 or 3
Depending on how you obtained LAMMPS, this directory has 2 or 3
sub-directories and optionally 2 PDF files and
2 ebook
file
s
:
sub-directories and optionally 2 PDF files and
an ePUB
file:
src content files for LAMMPS documentation
src content files for LAMMPS documentation
html HTML version of the LAMMPS manual (see html/Manual.html)
html HTML version of the LAMMPS manual (see html/Manual.html)
...
@@ -9,7 +9,6 @@ tools tools and settings for building the documentation
...
@@ -9,7 +9,6 @@ tools tools and settings for building the documentation
Manual.pdf large PDF version of entire manual
Manual.pdf large PDF version of entire manual
Developer.pdf small PDF with info about how LAMMPS is structured
Developer.pdf small PDF with info about how LAMMPS is structured
LAMMPS.epub Manual in ePUB format
LAMMPS.epub Manual in ePUB format
LAMMPS.mobi Manual in mobi format (required for for Kindle)
If you downloaded LAMMPS as a tarball from the web site, all these
If you downloaded LAMMPS as a tarball from the web site, all these
directories and files should be included.
directories and files should be included.
...
@@ -51,9 +50,7 @@ make pdf # generate 2 PDF files (Manual.pdf,Developer.pdf)
...
@@ -51,9 +50,7 @@ make pdf # generate 2 PDF files (Manual.pdf,Developer.pdf)
make old # generate old-style HTML pages in old dir via txt2html
make old # generate old-style HTML pages in old dir via txt2html
make fetch # fetch HTML doc pages and 2 PDF files from web site
make fetch # fetch HTML doc pages and 2 PDF files from web site
# as a tarball and unpack into html dir and 2 PDFs
# as a tarball and unpack into html dir and 2 PDFs
make ebook # generate e-book LAMMPS.epub in ePUB format using Sphinx
make epub # generate LAMMPS.epub in ePUB format using Sphinx
# optionally convert it to mobi format (for Kindle
# readers, requires "ebook-convert" from Calibre)
make clean # remove intermediate RST files created by HTML build
make clean # remove intermediate RST files created by HTML build
make clean-all # remove entire build folder and any cached data
make clean-all # remove entire build folder and any cached data
...
@@ -101,17 +98,18 @@ Installing prerequisites for PDF build
...
@@ -101,17 +98,18 @@ Installing prerequisites for PDF build
----------------
----------------
Installing prerequisites for e
book
build
Installing prerequisites for e
pub
build
## ePUB
## ePUB
Same as for HTML. This uses the same tools and configuration
Same as for HTML. This uses the same tools and configuration
files as the HTML tree.
files as the HTML tree.
## mobi
For converting the generated ePUB file to a mobi format file
For converting the generated ePUB file to a mobi format file
(for e-book readers, that cannot read ePUB), you also need to have
(for e-book readers like Kindle, that cannot read ePUB), you
the 'ebook-convert' tool from the "calibre" software installed.
also need to have the 'ebook-convert' tool from the "calibre"
http://calibre-ebook.com/
software installed. http://calibre-ebook.com/
You first create the ePUB file with 'make epub' and then do:
ebook-convert LAMMPS.epub LAMMPS.mobi
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment