You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,6 +64,33 @@ pre-commit run --all-files
64
64
65
65
9. Submit a pull request to the same branch you branched from
66
66
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:
0 commit comments