https://github.com/wumpyproject/docs
Documentation, guides and API Reference for official Wumpy subpackages
https://github.com/wumpyproject/docs
Last synced: about 1 month ago
JSON representation
Documentation, guides and API Reference for official Wumpy subpackages
- Host: GitHub
- URL: https://github.com/wumpyproject/docs
- Owner: wumpyproject
- License: other
- Created: 2022-01-25T22:41:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T19:47:34.000Z (almost 2 years ago)
- Last Synced: 2025-01-06T00:43:19.079Z (over 1 year ago)
- Language: CSS
- Size: 1000 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# The Wumpy project Documentation
Documentation, guide and API reference for official Wumpy subpackages.
## Setup
The documentation is written in Markdown using MKDocs. Simply install `mkdocs`
from PyPI with PIP:
```bash
pip install mkdocs
```
Once that is installed run the following command to serve the documentation
locally for development:
```bash
mkdocs serve
```
## Licensing
The Wumpy project documentation is permissively licensed under one of MIT or
Apache 2.0 (up to you). See the [LICENSE file](./LICENSE) for more.
This decision was made to have maximum compatibility and freedom.
## Contributing
Thank you for your interest in contributing. Compared to many other projects,
all kinds of changes are welcomed. If you're unsure how to get started please
read the [Contribution Guide](./CONTRIBUTING.md).