mirror of
https://github.com/vibrantlabsai/ragas.git
synced 2026-10-12 02:24:10 +00:00
Injae Ryou
592670b4bf
## Issue Link / Problem Description <!-- Link to related issue or describe the problem this PR solves --> - ragas/docs/INSTALL's guide is not working ```bash uv sync --extra docs --project ragas ``` ## Changes Made <!-- Describe what you changed and why --> - Successful install documentation dependencies ## Testing <!-- Describe how this should be tested --> ### How to Test - [ ] Automated tests added/updated - [x] Manual testing steps: ```bash uv sync --group docs --project ragas ``` ## References <!-- Link to related issues, discussions, forums, or external resources --> - Related issues: #2173 - Documentation: - External references: ## Screenshots/Examples (if applicable) <!-- Add screenshots or code examples showing the change --> --- <!-- Thank you for contributing to Ragas! Please fill out the sections above as completely as possible. The more information you provide, the faster your PR can be reviewed and merged. -->
29 lines
620 B
Plaintext
29 lines
620 B
Plaintext
# Documentation Development Setup
|
|
|
|
## Prerequisites
|
|
|
|
1. Install uv (Python package manager):
|
|
```bash
|
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
```
|
|
|
|
## Running Documentation Locally
|
|
|
|
1. Install documentation dependencies:
|
|
```bash
|
|
uv sync --group docs --project ragas
|
|
```
|
|
|
|
2. Serve the documentation:
|
|
```bash
|
|
source .venv/bin/activate && mkdocs serve --dirtyreload
|
|
```
|
|
|
|
The documentation will be available at http://127.0.0.1:8000/
|
|
|
|
## Run dev
|
|
|
|
You can also use the scripts command (after completing step 1 above and ensuring mkdocs is available in PATH):
|
|
```bash
|
|
./scripts/dev_docs.sh
|
|
``` |