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 angle docs #1770

Merged
merged 30 commits into from Nov 15, 2019
Merged

Update angle docs #1770

merged 30 commits into from Nov 15, 2019

Conversation

@rbberger
Copy link
Member

rbberger commented Nov 14, 2019

Summary

Updates the angle_* 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
ANGLES=$(grep -Rl Eqs src/* | grep angle)
python utils/converters/lammpsdoc/eqImg2mathjaxInline.py $ANGLES
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

Further Information, Files, and Links

@rbberger rbberger marked this pull request as ready for review Nov 15, 2019
@rbberger rbberger requested review from akohlmey and sjplimp Nov 15, 2019
akohlmey added 4 commits Nov 14, 2019
@akohlmey

This comment has been minimized.

Copy link
Member

akohlmey commented Nov 15, 2019

This now contains all documentation related changes from PR #1769

@rbberger rbberger merged commit 2e6b19e into lammps:master Nov 15, 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_math_changes branch Nov 15, 2019
@akohlmey akohlmey mentioned this pull request Nov 16, 2019
8 of 8 tasks complete
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.