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

Add Sphinx extension to generate tables from lists #1786

Merged
merged 7 commits into from Dec 2, 2019

Conversation

@rbberger
Copy link
Member

rbberger commented Nov 25, 2019

Summary

Introduces a table_from_list directive to Sphinx to simplify Command_*.rst files.

Related Issues

#1781

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).

Implementation Notes

Will generate an error when building PDF is a table doesn't have enough list elements to be divisible

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
  • 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

Put any additional information here, attach relevant text or image files, and URLs to external sites (e.g. DOIs or webpages)

@rbberger rbberger requested a review from akohlmey Nov 25, 2019
@akohlmey akohlmey requested a review from sjplimp Nov 25, 2019
@akohlmey akohlmey self-assigned this Nov 25, 2019
@akohlmey akohlmey mentioned this pull request Nov 25, 2019
0 of 10 tasks complete
Copy link
Member

akohlmey left a comment

OK with me, but I would wait until @sjplimp has had a look as well and agrees to the splitting of the Commands_bond.rst file. It could become a bit of a hassle to change it back later.

@akohlmey akohlmey assigned rbberger and unassigned akohlmey Nov 27, 2019
@sjplimp

This comment has been minimized.

Copy link
Contributor

sjplimp commented Nov 27, 2019

@rbberger I can't tell from the code what will change in the docs themselves.
Is it mainly splitting of the 4 bond/angle/etc tables on one page into 4 pages?
If it's possible, I think it's preferable to keep them on one HTML page, b/c there
is not that much info there, and by looking at multiple tables at the same time
a user can often figure out if the topology portion of their force field is supported.

@rbberger

This comment has been minimized.

Copy link
Member Author

rbberger commented Dec 1, 2019

@sjplimp as requested, I've put back the tables in Commands_bond.rst. Please approve so I can merge it.

@sjplimp
sjplimp approved these changes Dec 2, 2019
@rbberger rbberger merged commit 2f4adfc into lammps:master Dec 2, 2019
6 checks passed
6 checks passed
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_command_tables branch Dec 2, 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.