Skip to content

Commit 21a6ed5

Browse files
authored
📝 add instructions for previewing documentation (#435)
1 parent 3e2ffe6 commit 21a6ed5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,17 @@ All [documentation] lives in the `README.md`. Please read it carefully
186186
before proposing any changes. Ensure that the markdown is formatted correctly
187187
with [markdownlint](https://github.com/DavidAnson/markdownlint/tree/main).
188188

189+
### Previewing Documentation Site
190+
191+
NumType uses [MkDocs] for documentation static site generation. To preview the documentation site locally:
192+
193+
```shell
194+
uv run mkdocs serve
195+
```
196+
197+
This will start a local server at <http://127.0.0.1:8000/numtype/> where you can preview your changes.
198+
The server automatically refreshes when you make changes to the documentation files.
199+
189200
## Development Tools
190201

191202
NumType provides several development tools to help with development.
@@ -215,5 +226,6 @@ one of the development dependencies.
215226
[stub-style]: https://typing.python.org/en/latest/guides/writing_stubs.html#style-guide
216227
[test-docs]: https://github.com/numpy/numtype/tree/main/test
217228
[tool-docs]: https://github.com/numpy/numtype/tree/main/tool
229+
[MkDocs]: https://www.mkdocs.org/
218230

219231
<!--overview-end-->

0 commit comments

Comments
 (0)