Skip to content

Commit aedf36b

Browse files
committed
update readme
1 parent 1badd0e commit aedf36b

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -167,15 +167,15 @@ The project documentation is built with [Material for MkDocs](https://squidfunk.
167167
Install development dependencies:
168168

169169
```bash
170-
poetry install --with dev
170+
hatch env create
171171
```
172172

173173
#### Local Development
174174

175175
To serve the documentation locally with live reload:
176176

177177
```bash
178-
poetry run mkdocs serve
178+
hatch run docs-serve
179179
```
180180

181181
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/
185185
To build the documentation for production:
186186

187187
```bash
188-
poetry run python -W ignore::DeprecationWarning:mkdocs_autorefs -m mkdocs build --clean --strict
188+
hatch run docs-build
189189
```
190190

191191
The built documentation will be in the `site/` directory.
192192

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.
194194

195195
For local development without strict mode:
196196

197197
```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
199200
```
200201

201202
#### Documentation Structure

0 commit comments

Comments
 (0)