From 8efb48480a8262b0ae7dbcdd5e6ae4c4654d5efc Mon Sep 17 00:00:00 2001 From: Halvor Lund Date: Mon, 3 Jun 2024 12:24:09 +0200 Subject: [PATCH] Improve development docs in readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 8170e17..f6b07e1 100644 --- a/README.md +++ b/README.md @@ -91,3 +91,15 @@ poetry install Remember that when developing a library it is *not* recommended to commit the `poetry.lock` file. + +### Generate docs +To generate docs locally: +- Install required dependencies with `peotry install --with docs`. +- Generate docs with `poetry run make html` in the `docs` folder. + +### Release new version +Press the "Draft new release" button on the [Releases](https://github.com/statnett/linerate/releases) page. +Choose or create an appropriate tag, e.g. `1.2.3`. +Press "Generate release notes" to generate release notes. +Edit Release notes if necessary and press "Publish release". +This causes the publish workflow to run, which publishes the package to PyPI and generates [docs on Github pages](https://statnett.github.io/linerate/).