Skip to content

Commit

Permalink
add documentation section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mstechly committed May 3, 2024
1 parent cd3e95f commit 6c5ded9
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,11 @@ program = SchemaV1.model_validate(data)

## Development

In order to install development environment or build documentation locally, please refer to [Development Guide](https://psiq.github.io/qref/latest/development/).
In order to install development environment or build documentation locally, please refer to [Development Guide](https://psiq.github.io/qref/latest/development/).


## Documentation

Documentation for `qref` can be found [here](https://psiq.github.io/qref/latest/).

To run docs locally install it with `docs` option: `pip install ".[docs]"` (or `poetry install --with docs`) and then run `mkdocs serve`.

0 comments on commit 6c5ded9

Please sign in to comment.