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: README.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,15 +167,15 @@ The project documentation is built with [Material for MkDocs](https://squidfunk.
167
167
Install development dependencies:
168
168
169
169
```bash
170
-
poetry install --with dev
170
+
hatch env create
171
171
```
172
172
173
173
#### Local Development
174
174
175
175
To serve the documentation locally with live reload:
176
176
177
177
```bash
178
-
poetry run mkdocs serve
178
+
hatch run docs-serve
179
179
```
180
180
181
181
The documentation will be available at http://127.0.0.1:8000/
@@ -185,17 +185,18 @@ The documentation will be available at http://127.0.0.1:8000/
185
185
To build the documentation for production:
186
186
187
187
```bash
188
-
poetry run python -W ignore::DeprecationWarning:mkdocs_autorefs -m mkdocs build --clean --strict
188
+
hatch run docs-build
189
189
```
190
190
191
191
The built documentation will be in the `site/` directory.
192
192
193
-
**Important:**Always use the `--strict` flag when building documentation to catch warnings as errors. This ensures documentation quality and prevents deployment of documentation with issues.
193
+
**Important:**The documentation build uses the `--strict` flag to catch warnings as errors. This ensures documentation quality and prevents deployment of documentation with issues.
194
194
195
195
For local development without strict mode:
196
196
197
197
```bash
198
-
poetry run mkdocs build
198
+
hatch run mkdocs build
199
+
hatch run +py=3.8 mkdocs build # to build in a specific python environment only, not all
0 commit comments