mirror of
https://github.com/containers/ramalama.git
synced 2026-02-05 15:47:26 +01:00
b630fcdea2
Add ramalama rag --format option to allow outputing of markdown, json as well as qdrant databases. This content can then be used as input to the client tool. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Co-authored-by: Ian Eaves <ian.k.eaves@gmail.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
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
ramalamadirectory
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)