Update bond docs #1775

rbberger · 2019-11-17T04:06:35Z

Summary

Updates the bond_* pages to embed mathematical equations directly in RST. Removes the Eqs JPEGs, TeX files, and txt files.

Related Issues
#1533
#1643

Author(s)

@rbberger

Licensing

By submitting this pull request, I agree, that my contribution will be included in LAMMPS and redistributed under either the GNU General Public License version 2 (GPL v2) or the GNU Lesser General Public License version 2.1 (LGPL v2.1).

Backward Compatibility

yes

Implementation Notes

Used tool by @eagunn and then fixed up the pages manually.

cd doc
BONDS=$(grep -Rl Eqs src/* | grep bond)
python utils/converters/lammpsdoc/eqImg2mathjaxInline.py $BONDS
cp modifiedRst/* src/
rm -rf modifiedRst safeRst

Post Submission Checklist

Please check the fields below as they are completed after the pull request has been submitted. Delete lines that don't apply

The feature or features in this pull request is complete
Licensing information is complete
Corresponding author information is complete
The source code follows the LAMMPS formatting guidelines
Suitable new documentation files and/or updates to the existing docs are included
The added/updated documentation is integrated and tested with the documentation build system


        Update docs: atom_modify


        Update docs: atom_style


        Update docs: bond_class2


        Update docs: bond_fene


        Update docs: bond_fene_expand


        Update docs: bond_gromos


        Update docs: bond_harmonic


        Update docs: pair_list


        Update docs: bond_harmonic_shift


        Update docs: bond_harmonic_shift_cut


        Update docs: bond_mm3


        Update docs: bond_morse


        Update docs: bond_nonlinear


        Update docs: bond_oxdna


        Update docs: bond_quartic


        Update docs: bond_coeff


        Update docs: bond_write


        Update docs: bond_style


        Update docs: bond_zero


        Update docs: bond_none


        Update docs: bond_table


        Update docs: bond_hybrid


        Fix pdf build


        Update CMake-based doc build

rbberger added 22 commits Nov 16, 2019

Update docs: atom_modify

4b6265a

Update docs: atom_style

a1d226f

Update docs: bond_class2

98bd975

Update docs: bond_fene

5f89fde

Update docs: bond_fene_expand

a3b3b76

Update docs: bond_gromos

5760de0

Update docs: bond_harmonic

4a1e9d9

Update docs: pair_list

41c0d69

Update docs: bond_harmonic_shift

fed5d07

Update docs: bond_harmonic_shift_cut

7aa74ac

Update docs: bond_mm3

64c31b3

Update docs: bond_morse

35181a6

Update docs: bond_nonlinear

48485f1

Update docs: bond_oxdna

2150415

Update docs: bond_quartic

d13ec0d

Update docs: bond_coeff

9780fd3

Update docs: bond_write

c5c7e69

Update docs: bond_style

2a900f8

Update docs: bond_zero

18a86a9

Update docs: bond_none

1b4e84d

Update docs: bond_table

ff9f93b

Update docs: bond_hybrid

Loading status checks…

d6b1e30

rbberger added the documentation label Nov 17, 2019

rbberger requested review from akohlmey and sjplimp Nov 17, 2019

rbberger added 2 commits Nov 17, 2019

Fix pdf build

Loading status checks…

3ff3621

Update CMake-based doc build

Loading status checks…

19b265f

sjplimp approved these changes Nov 18, 2019

View changes

akohlmey self-assigned this Nov 18, 2019

akohlmey added this to the Stable Release Winter 2019/2020 milestone Nov 18, 2019

rbberger deleted the rbberger:doc_updates branch Nov 19, 2019

lammps/lammps

Update bond docs #1775

Update bond docs #1775

rbberger commented Nov 17, 2019

lammps/lammps

Join GitHub today

Update bond docs #1775

Update bond docs #1775

Conversation

rbberger commented Nov 17, 2019