Skip to content

Commit cdc4cda

Browse files
authored
Merge pull request #1 from mmacy/doc-build-docs
Add documentation build section to CONTRIBUTING.md
2 parents d1ac8d6 + 08ecdb0 commit cdc4cda

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,33 @@ pre-commit run --all-files
6464

6565
9. Submit a pull request to the same branch you branched from
6666

67+
## Building and viewing documentation
68+
69+
To build and view the documentation locally:
70+
71+
1. Install documentation dependencies (included with `--dev` flag above):
72+
73+
```bash
74+
uv sync --frozen --group docs
75+
```
76+
77+
2. Serve the documentation locally:
78+
79+
```bash
80+
uv run mkdocs serve
81+
```
82+
83+
**Note for macOS users**: If you encounter a [Cairo library error](https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/#cairo-library-was-not-found), set the library path before running mkdocs:
84+
85+
```bash
86+
export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib
87+
uv run mkdocs serve
88+
```
89+
90+
3. Open your browser to `http://127.0.0.1:8000/python-sdk/` to view the documentation
91+
92+
The documentation will auto-reload when you make changes to files in `docs/`, `mkdocs.yml`, or `src/mcp/`.
93+
6794
## Code Style
6895

6996
- We use `ruff` for linting and formatting

0 commit comments

Comments
 (0)