diff --git a/doc/Makefile b/doc/Makefile index eceae88da6..a3c4906cec 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -31,7 +31,7 @@ SPHINXEXTRA = -j $(shell $(PYTHON) -c 'import multiprocessing;print(multiprocess SOURCES=$(filter-out $(wildcard $(TXTDIR)/lammps_commands*.txt) $(TXTDIR)/lammps_support.txt $(TXTDIR)/lammps_tutorials.txt,$(wildcard $(TXTDIR)/*.txt)) OBJECTS=$(SOURCES:$(TXTDIR)/%.txt=$(RSTDIR)/%.rst) -.PHONY: help clean-all clean epub mobi rst html pdf venv spelling anchor_check +.PHONY: help clean-all clean epub mobi rst html pdf venv spelling anchor_check style_check # ------------------------------------------ @@ -46,6 +46,7 @@ help: @echo " clean remove all intermediate RST files" @echo " clean-all reset the entire build environment" @echo " anchor_check scan for duplicate anchor labels" + @echo " style_check check for complete and consistent style lists" @echo " spelling spell-check the manual" # ------------------------------------------ @@ -69,6 +70,7 @@ html: $(OBJECTS) $(ANCHORCHECK) echo "############################################" ;\ rst_anchor_check src/*.rst ;\ env LC_ALL=C grep -n '[^ -~]' $(RSTDIR)/*.rst ;\ + python utils/check-styles.py -s ../src -d src ;\ echo "############################################" ;\ deactivate ;\ ) @@ -122,24 +124,27 @@ pdf: $(OBJECTS) $(ANCHORCHECK) cd ../../; \ ) @(\ - . $(VENV)/bin/activate ;\ - sphinx-build $(SPHINXEXTRA) -b latex -c utils/sphinx-config -d $(BUILDDIR)/doctrees $(RSTDIR) latex ;\ - echo "############################################" ;\ - rst_anchor_check src/*.rst ;\ - echo "############################################" ;\ - deactivate ;\ + . $(VENV)/bin/activate ;\ + sphinx-build $(SPHINXEXTRA) -b latex -c utils/sphinx-config -d $(BUILDDIR)/doctrees $(RSTDIR) latex ;\ + echo "############################################" ;\ + rst_anchor_check src/*.rst ;\ + env LC_ALL=C grep -n '[^ -~]' $(RSTDIR)/*.rst ;\ + python utils/check-styles.py -s ../src -d src ;\ + echo "############################################" ;\ + deactivate ;\ ) @cd latex && \ - sed 's/latexmk -pdf -dvi- -ps-/pdflatex/g' Makefile > temp && \ - mv temp Makefile && \ - sed 's/\\begin{equation}//g' LAMMPS.tex > tmp.tex && \ - mv tmp.tex LAMMPS.tex && \ - sed 's/\\end{equation}//g' LAMMPS.tex > tmp.tex && \ - mv tmp.tex LAMMPS.tex && \ - make && \ - make && \ - mv LAMMPS.pdf ../Manual.pdf && \ - cd ../; + sed 's/latexmk -pdf -dvi- -ps-/pdflatex/g' Makefile > temp && \ + mv temp Makefile && \ + sed 's/\\begin{equation}//g' LAMMPS.tex > tmp.tex && \ + mv tmp.tex LAMMPS.tex && \ + sed 's/\\end{equation}//g' LAMMPS.tex > tmp.tex && \ + mv tmp.tex LAMMPS.tex && \ + make && \ + make && \ + make && \ + mv LAMMPS.pdf ../Manual.pdf && \ + cd ../; @rm -rf latex/_sources @rm -rf latex/PDF @rm -rf latex/USER @@ -166,6 +171,13 @@ anchor_check : $(ANCHORCHECK) deactivate ;\ ) +style_check : + @(\ + . $(VENV)/bin/activate ;\ + python utils/check-styles.py -s ../src -d src ;\ + deactivate ;\ + ) + # ------------------------------------------ $(RSTDIR)/%.rst : $(TXTDIR)/%.txt $(TXT2RST) diff --git a/doc/src/Build_extras.rst b/doc/src/Build_extras.rst index c02b24641e..2cba59bde0 100644 --- a/doc/src/Build_extras.rst +++ b/doc/src/Build_extras.rst @@ -203,7 +203,7 @@ inside the CMake build directory. If the KIM library is already on your system (in a location CMake cannot find it), set the PKG\_CONFIG\_PATH environment variable so that libkim-api can be found. -For using KIM web queries. +For using OpenKIM web queries in LAMMPS. If LMP\_DEBUG\_CURL is set, the libcurl verbose mode will be on, and any libcurl calls within the KIM web query display a lot of information about diff --git a/doc/src/Commands_all.rst b/doc/src/Commands_all.rst index d47c3299d0..5ad8fff44c 100644 --- a/doc/src/Commands_all.rst +++ b/doc/src/Commands_all.rst @@ -25,26 +25,26 @@ An alphabetic list of all general LAMMPS commands. * :doc:`atom_style ` * :doc:`balance ` * :doc:`bond_coeff ` - * :doc:`bond\_style ` - * :doc:`bond\_write ` + * :doc:`bond_style ` + * :doc:`bond_write ` * :doc:`boundary ` * :doc:`box ` - * :doc:`change\_box ` + * :doc:`change_box ` * :doc:`clear ` - * :doc:`comm\_modify ` - * :doc:`comm\_style ` + * :doc:`comm_modify ` + * :doc:`comm_style ` * :doc:`compute ` - * :doc:`compute\_modify ` - * :doc:`create\_atoms ` - * :doc:`create\_bonds ` - * :doc:`create\_box ` - * :doc:`delete\_atoms ` - * :doc:`delete\_bonds ` + * :doc:`compute_modify ` + * :doc:`create_atoms ` + * :doc:`create_bonds ` + * :doc:`create_box ` + * :doc:`delete_atoms ` + * :doc:`delete_bonds ` * :doc:`dielectric ` - * :doc:`dihedral\_coeff ` - * :doc:`dihedral\_style ` + * :doc:`dihedral_coeff ` + * :doc:`dihedral_style ` * :doc:`dimension ` - * :doc:`displace\_atoms ` + * :doc:`displace_atoms ` * :doc:`dump ` * :doc:`dump adios ` * :doc:`dump image ` @@ -52,75 +52,77 @@ An alphabetic list of all general LAMMPS commands. * :doc:`dump netcdf ` * :doc:`dump netcdf/mpiio ` * :doc:`dump vtk ` - * :doc:`dump\_modify ` - * :doc:`dynamical\_matrix ` + * :doc:`dump_modify ` + * :doc:`dynamical_matrix ` * :doc:`echo ` * :doc:`fix ` - * :doc:`fix\_modify ` + * :doc:`fix_modify ` * :doc:`group ` * :doc:`group2ndx ` * :doc:`hyper ` * :doc:`if ` - * :doc:`improper\_coeff ` - * :doc:`improper\_style ` + * :doc:`improper_coeff ` + * :doc:`improper_style ` * :doc:`include ` + * :doc:`info ` * :doc:`jump ` - * :doc:`kim\_init ` - * :doc:`kim\_interactions ` - * :doc:`kim\_query ` - * :doc:`kspace\_modify ` - * :doc:`kspace\_style ` + * :doc:`kim_init ` + * :doc:`kim_interactions ` + * :doc:`kim_param ` + * :doc:`kim_query ` + * :doc:`kspace_modify ` + * :doc:`kspace_style ` * :doc:`label