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 LAMMPSLexer for LAMMPS code-blocks in docs #1762

Merged
merged 3 commits into from Nov 7, 2019

Conversation

@rbberger
Copy link
Member

rbberger commented Nov 6, 2019

Summary

Adds a Pygments lexer to the documentation build to add syntax highlighting to LAMMPS examples. Updates a few documentation pages to showcase the result.

Example for offline usage:

pygmentize -l doc/utils/sphinx-config/LAMMPSLexer.py:LAMMPSLexer -x examples/melt/in.melt

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

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

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)

@akohlmey akohlmey requested review from athomps and sjplimp Nov 7, 2019
@akohlmey akohlmey self-assigned this Nov 7, 2019
@sjplimp
sjplimp approved these changes Nov 7, 2019
@akohlmey akohlmey merged commit 6d7a591 into lammps:master Nov 7, 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
@rbberger rbberger deleted the rbberger:doc_lammps_lexer branch Nov 14, 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.