gunicorn/docs/README.md

28 lines
434 B
Markdown

# Generate Documentation
## Requirements
Install the documentation dependencies with:
```bash
pip install -r requirements_dev.txt
```
This provides MkDocs with the Material theme and supporting plugins.
## Build static HTML
```bash
mkdocs build
```
The rendered site is emitted into the `site/` directory.
## Preview locally
```bash
mkdocs serve
```
This serves the documentation at http://127.0.0.1:8000/ with live reload.