Skip to content

📝 add instructions for previewing documentation site #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jorenham merged 1 commit into from
Mar 30, 2025
Merged

📝 add instructions for previewing documentation site #435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://127.0.0.1:8000/numtype/> 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.
Expand Down Expand Up @@ -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/

<!--overview-end-->