File tree Expand file tree Collapse file tree 1 file changed +12
-0
lines changed
Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Original file line number Diff line number Diff line change @@ -186,6 +186,17 @@ All [documentation] lives in the `README.md`. Please read it carefully
186186before proposing any changes. Ensure that the markdown is formatted correctly
187187with [ 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
191202NumType 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-->
You can’t perform that action at this time.
0 commit comments