1
0
mirror of https://github.com/containers/ramalama.git synced 2026-02-05 15:47:26 +01:00
Files
ramalama/docs/README.md
Grace Chin c4777a9ccc Add documentation about running tests
Signed-off-by: Grace Chin <gchin@redhat.com>
2025-06-04 11:55:57 -04:00

882 B

RamaLama Docs

RamaLama uses man pages

Directory Structure

Description Directory
Markdown source for man pages docs/*md
target for output docs/*.[15]
man pages docs/*.[15]

Build the Docs

To build standard man pages,

  • Make sure in ramalama directory
cd ramalama
  • Install tools
make install-tools
  • Make the man docs
make docs
  • Results will be in docs
cd docs

Run the Tests

To run the tests,

  • Install pytest

  • Run tests with

pytest

or

pytest path/to/test_file.py

(which runs an individual test file)