README.md

# [Self Data Grandlyon Documentation](https://doc-self-data.apps.grandlyon.com/)

## Install dependencies

```sh
pip install -r  ./requirements/docs.txt
```

## Commands

- `mkdocs serve` - Start the live-reloading docs server.
- `mkdocs build` - Build the documentation site.
- `mkdocs help` - Print this help message.

## Files hierarchy

When adding new pages, add it respectively to the [mkdocs.yml](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc/-/blob/master/mkdocs.yml#L46)

## Mkdocs Reference

[mkdocs features](https://squidfunk.github.io/mkdocs-material/reference/)