From d4cd67ce74ed3edc4cd89f6ba4d419ed4a0b0e31 Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Fri, 18 Sep 2020 17:15:42 -0400 Subject: [PATCH] tweak format some more and refactor manual sectioning to be logically correct now if only there was a way to make the titles of the parts show in the navigation sidebar. --- doc/src/Manual.rst | 22 +++++++++---------- .../sphinx-config/_static/css/lammps.css | 3 +++ doc/utils/sphinx-config/false_positives.txt | 6 +++++ 3 files changed, 20 insertions(+), 11 deletions(-) diff --git a/doc/src/Manual.rst b/doc/src/Manual.rst index 7c715239df..fbaeef507f 100644 --- a/doc/src/Manual.rst +++ b/doc/src/Manual.rst @@ -1,13 +1,8 @@ -LAMMPS Documentation -#################### +LAMMPS version |version| Documentation +###################################### -|version| version -***************** - -:doc:`What is a LAMMPS version? ` - -LAMMPS stands for Large-scale Atomic/Molecular Massively Parallel -Simulator. +LAMMPS stands for **L**\ arge-scale **A**\ tomic/**M**\ olecular +**M**\ assively **P**\ arallel **S**\ imulator. LAMMPS is a classical molecular dynamics simulation code with a focus on materials modeling. It was designed to run efficiently on parallel @@ -39,11 +34,14 @@ every LAMMPS command. .. _lws: https://lammps.sandia.gov +User Documentation +****************** + +.. :caption: User Documentation .. _user_documentation: .. toctree:: :maxdepth: 2 :numbered: 3 - :caption: User Documentation :name: userdoc :includehidden: @@ -61,11 +59,13 @@ every LAMMPS command. Errors Manual_build +Programmer Documentation +************************ +.. :caption: Programmer Documentation .. _programmer_documentation: .. toctree:: :maxdepth: 2 :numbered: 3 - :caption: Programmer Documentation :name: progdoc :includehidden: diff --git a/doc/utils/sphinx-config/_static/css/lammps.css b/doc/utils/sphinx-config/_static/css/lammps.css index bfdbad4aa7..79d3aa36f6 100644 --- a/doc/utils/sphinx-config/_static/css/lammps.css +++ b/doc/utils/sphinx-config/_static/css/lammps.css @@ -45,3 +45,6 @@ hr { margin: 0; } +p { + margin-bottom: 12px; +} diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index 73041d8c02..b276933a88 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -110,7 +110,9 @@ api Apoorva Appl Apu +arallel arccos +arge Archlinux arcsin arg @@ -128,6 +130,7 @@ aspherical asphericity Asq assignee +assively Asta Astart Astop @@ -1303,6 +1306,7 @@ Impey impl impropers Impropers +imulator includelink incompressible incrementing @@ -2255,6 +2259,7 @@ Okamoto O'Keefe OKeefe oldlace +olecular Oleinik Olfason olivedrab @@ -3107,6 +3112,7 @@ Tohoku tokenizer tokyo tol +tomic toolchain topologies Toporov