https://github.com/chazeon/lammps-docset

Offline documentation for LAMMPS
https://github.com/chazeon/lammps-docset

docset documentation lammps molecular-dynamics

Last synced: about 1 month ago
JSON representation

Offline documentation for LAMMPS

• Host: GitHub
• URL: https://github.com/chazeon/lammps-docset
• Owner: chazeon
• License: mit
• Created: 2022-05-11T01:48:27.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-04T17:19:04.000Z (about 2 years ago)
• Last Synced: 2023-08-03T01:11:09.222Z (over 1 year ago)
• Topics: docset, documentation, lammps, molecular-dynamics
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LAMMPS Docset

Build a docset from a LAMMPS archive for offline API documentation browsers such as [Dash](https://kapeli.com/dash) and [Zeal](https://zealdocs.org/).

## How to ...

### Use GitHub Actions to build the docset

- Go to [workflow dispatch][1].

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

[1]: https://github.com/chazeon/lammps-docset/actions/workflows/build.yml

### Build locally

- Install Doxygen

- Install build requirements

  ```sh

  pip install -r requirements.txt

  ```

- Use the [Makefile](./Makefile) to build documents, it will download the archive automatically.

  ```sh

  make docset

  ```

## Licence

Licenced under the [MIT licence](./LICENSE).