Skip to content

Update docs building instructions in readme #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
freetonik wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update docs building instructions in readme #66

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
851fec8
Update docs building instructions in readme
freetonik Dec 9, 2025
22f867c
Use uv dev group for docs
Dec 9, 2025
c89df0b
move docs deps into dev group
shamrin Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,12 @@ uv run python example.py

### Generating the documentation

If added a new service, create a documentation template under api/services for that service.
If added a new service, create a documentation template under `api/services` for that service.

```bash
cd docs
make html
uv pip install -r requirements.txt
uv run make html
Comment thread
shamrin marked this conversation as resolved.
```

### Code style
Expand Down