Skip to content

Commit

Permalink
Improve development docs in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Halvor Lund committed Jun 3, 2024
1 parent fd2f3bf commit a85622b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `poetry 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/).

0 comments on commit a85622b

Please sign in to comment.