/lammps-docset

Offline documentation for LAMMPS

Primary LanguagePythonMIT LicenseMIT

LAMMPS Docset

Build a docset from a LAMMPS archive for offline API documentation browsers such as Dash and Zeal.

How to ...

Use GitHub Actions to build the docset

  • Go to workflow dispatch.
  • Click "Run workflow" button.
  • Set the URL for LAMMPS archive, such as https://download.lammps.org/tars/lammps-23Jun2022.tar.gz, if you leave it empty, it will use the latest LAMMPS build.
  • Click the green "Run workflow" button.
  • Wait for the workflow to finish.
  • Download the payload from the successful workflow run.

Build locally

  • Install Doxygen
  • Install build requirements 
    pip install -r requirements.txt
  • Use the Makefile to build documents, it will download the archive automatically. 
    make docset

Licence

Licenced under the MIT licence.