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 documentation tools and paths #1761

Merged
merged 6 commits into from Nov 6, 2019
Merged

Conversation

@rbberger
Copy link
Member

rbberger commented Nov 5, 2019

Summary

  • moves doc/src/*.txt files to doc/txt/
  • moves doc/rst/*.rst files to src/
  • adds updated tools from #1533
  • some edits in rst files

Note: if any *.rst file is changed, that means the *.txt file is outdated. We are not backporting anymore, therefore the *.txt file should be deleted!

Related Issues
#1643

Author(s)

@rbberger
@eagunn

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

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
  • The feature has been verified to work with the conventional build system
  • The feature has been verified to work with the CMake based build system
  • A package specific README file has been included or updated
  • One or more example input decks are included
@rbberger rbberger requested a review from eofetis Nov 5, 2019
@rbberger rbberger force-pushed the rbberger:doc_updates branch from d21df4d to 5e6694f Nov 5, 2019
@rbberger rbberger removed the request for review from eofetis Nov 6, 2019
@akohlmey

This comment has been minimized.

Copy link
Member

akohlmey commented Nov 6, 2019

@rbberger is this going to include all changes that we want to incorporate from #1533?
Or will there be another PR with another set of changes?

@rbberger

This comment has been minimized.

Copy link
Member Author

rbberger commented Nov 6, 2019

@akohlmey there is a lot of changes to Eqs that we should leverage, however there is no easy merge for this. I'll be looking into porting as much as possible by hand so it's not a wasted effort.

@rbberger

This comment has been minimized.

Copy link
Member Author

rbberger commented Nov 6, 2019

We can merge this one once it clears the checks, I will create more PRs.

@akohlmey akohlmey merged commit bb18adc into lammps:master Nov 6, 2019
8 checks passed
8 checks passed
lammps/pull-requests/build-docs-pr head run ended
Details
lammps/pull-requests/cmake/cmake-kokkos-cuda-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
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.