From 7a41f20747d1fc058e5915f623438fbb8ac2277c Mon Sep 17 00:00:00 2001 From: GUAN MING Date: Sun, 30 Mar 2025 11:35:06 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20add=20instructions=20for=20previ?= =?UTF-8?q?ewing=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2c709de..b66caae7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -186,6 +186,17 @@ All [documentation] lives in the `README.md`. Please read it carefully before proposing any changes. Ensure that the markdown is formatted correctly with [markdownlint](https://github.com/DavidAnson/markdownlint/tree/main). +### Previewing Documentation Site + +NumType uses [MkDocs] for documentation static site generation. To preview the documentation site locally: + +```shell +uv run mkdocs serve +``` + +This will start a local server at where you can preview your changes. +The server automatically refreshes when you make changes to the documentation files. + ## Development Tools NumType provides several development tools to help with development. @@ -215,5 +226,6 @@ one of the development dependencies. [stub-style]: https://typing.python.org/en/latest/guides/writing_stubs.html#style-guide [test-docs]: https://github.com/numpy/numtype/tree/main/test [tool-docs]: https://github.com/numpy/numtype/tree/main/tool +[MkDocs]: https://www.mkdocs.org/