diff --git a/doc/src/Manual.txt b/doc/src/Manual.txt index a9cfe9654f..a6f3d75817 100644 --- a/doc/src/Manual.txt +++ b/doc/src/Manual.txt @@ -106,6 +106,9 @@ it gives quick access to documentation for all LAMMPS commands. .. toctree:: :maxdepth: 2 :numbered: + :caption: User Documentation + :name: userdoc + :includehidden: Section_intro Section_start @@ -121,6 +124,20 @@ it gives quick access to documentation for all LAMMPS commands. Section_errors Section_history +.. toctree:: + :caption: Index + :name: index + :hidden: + + tutorials + commands + fixes + computes + pairs + bonds + angles + dihedrals + impropers Indices and tables ================== diff --git a/doc/src/Section_accelerate.txt b/doc/src/Section_accelerate.txt index ed6a233a2d..fcdcb2d41c 100644 --- a/doc/src/Section_accelerate.txt +++ b/doc/src/Section_accelerate.txt @@ -157,11 +157,25 @@ packages"_Section_packages.html. These are the accelerator packages currently in LAMMPS, either as standard or user packages: -"GPU Package"_accelerate_gpu.html with CUDA and OpenCL support for Nvidia GPUs and others :h5 -"USER-INTEL Package"_accelerate_intel.html for Intel CPUs and Intel Xeon Phi :h5 -"KOKKOS Package"_accelerate_kokkos.html for Nvidia GPUs, Intel Xeon Phi, and OpenMP threading :h5 -"USER-OMP Package "_accelerate_omp.html for OpenMP threading and generic CPU optimizations :h5 -"OPT Package"_accelerate_opt.html generic CPU optimizations :h5 +"GPU Package"_accelerate_gpu.html : for NVIDIA GPUs as well as OpenCL support +"USER-INTEL Package"_accelerate_intel.html : for Intel CPUs and Intel Xeon Phi +"KOKKOS Package"_accelerate_kokkos.html : for Nvidia GPUs, Intel Xeon Phi, and OpenMP threading +"USER-OMP Package"_accelerate_omp.html : for OpenMP threading and generic CPU optimizations +"OPT Package"_accelerate_opt.html : generic CPU optimizations :tb(s=:) + + Inverting this list, LAMMPS currently has acceleration support for three kinds of hardware, via the listed packages: diff --git a/doc/src/angles.txt b/doc/src/angles.txt new file mode 100644 index 0000000000..ff1f68d45a --- /dev/null +++ b/doc/src/angles.txt @@ -0,0 +1,27 @@ +Angle Styles :h1 + + diff --git a/doc/src/bonds.txt b/doc/src/bonds.txt new file mode 100644 index 0000000000..fdc3d23c13 --- /dev/null +++ b/doc/src/bonds.txt @@ -0,0 +1,22 @@ +Bonds :h1 + + diff --git a/doc/src/commands.txt b/doc/src/commands.txt new file mode 100644 index 0000000000..958a6f34f4 --- /dev/null +++ b/doc/src/commands.txt @@ -0,0 +1,109 @@ +Commands :h1 + + diff --git a/doc/src/computes.txt b/doc/src/computes.txt new file mode 100644 index 0000000000..e7e54a6b3b --- /dev/null +++ b/doc/src/computes.txt @@ -0,0 +1,120 @@ +Computes :h1 + + diff --git a/doc/src/dihedrals.txt b/doc/src/dihedrals.txt new file mode 100644 index 0000000000..500a6a52bf --- /dev/null +++ b/doc/src/dihedrals.txt @@ -0,0 +1,39 @@ +Dihedral Styles :h1 + + diff --git a/doc/src/fixes.txt b/doc/src/fixes.txt new file mode 100644 index 0000000000..48a4c805a4 --- /dev/null +++ b/doc/src/fixes.txt @@ -0,0 +1,157 @@ +Fixes :h1 + + diff --git a/doc/src/impropers.txt b/doc/src/impropers.txt new file mode 100644 index 0000000000..ced6128879 --- /dev/null +++ b/doc/src/impropers.txt @@ -0,0 +1,20 @@ +Improper Styles :h1 + + diff --git a/doc/src/pairs.txt b/doc/src/pairs.txt new file mode 100644 index 0000000000..77f4fba807 --- /dev/null +++ b/doc/src/pairs.txt @@ -0,0 +1,102 @@ +Pair Styles :h1 + + diff --git a/doc/src/tutorials.txt b/doc/src/tutorials.txt new file mode 100644 index 0000000000..98c748f3af --- /dev/null +++ b/doc/src/tutorials.txt @@ -0,0 +1,13 @@ +Tutorials :h1 + +