Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update bond docs #1775

Merged
merged 24 commits into from Nov 18, 2019
Merged

Update bond docs #1775

merged 24 commits into from Nov 18, 2019

Conversation

@rbberger
Copy link
Member

rbberger commented Nov 17, 2019

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
@rbberger rbberger requested review from akohlmey and sjplimp Nov 17, 2019
rbberger added 2 commits Nov 17, 2019
@akohlmey akohlmey self-assigned this Nov 18, 2019
@akohlmey akohlmey merged commit fbf280f into lammps:master Nov 18, 2019
7 checks passed
7 checks passed
lammps/pull-requests/build-docs-pr head run ended
Details
lammps/pull-requests/cmake/cmake-kokkos-omp-pr head run ended
Details
lammps/pull-requests/cmake/cmake-serial-pr head run ended
Details
lammps/pull-requests/kokkos-omp-pr head run ended
Details
lammps/pull-requests/openmpi-pr head run ended
Details
lammps/pull-requests/serial-pr head run ended
Details
lammps/pull-requests/shlib-pr head run ended
Details
@rbberger rbberger deleted the rbberger:doc_updates branch Nov 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.