Skip to content

Commit

Permalink
Merge pull request #132 from ImperialCollegeLondon/hatch-patch
Browse files Browse the repository at this point in the history
patch hatch
  • Loading branch information
barneydobson authored Nov 27, 2024
2 parents a0cd113 + 24558f4 commit 89d0ca2
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 595 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:

- name: Install and build
run: |
python -m pip install -r requirements-dev.txt
python -m pip install .[dev]
python -m pip install .
- name: Run tests
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:
python-version: "3.11"

- name: Install dependencies
run: pip install -r requirements-doc.txt
run: pip install .[doc]

- name: Deploy Docs
run: mkdocs gh-deploy --force
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,7 @@ cython_debug/

# Scratch folder to do testing
scratch
results
results

# Version
_version.py
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ cd wsi
We use [`pip-tools`](https://pip-tools.readthedocs.io/en/latest/) to ensure consistency in the development process, ensuring all people contributing to WSIMOD uses the same versions for all the dependencies, which minimiese the conflicts. To install the development dependencies and then WISMO in development mode run:

```bash
pip install -r requirements-dev.txt
pip install .[dev]
pip install -e .
```

You can also install the dependencies required to run the demos and tutorials with:

```bash
pip install -r requirements-demos.txt
pip install .[demos]
```

## Quality assurance and linting
Expand Down Expand Up @@ -90,7 +90,7 @@ coverage html
If you want to compile new documentation you will need some additional packages, installed with:

```bash
pip install -r requirements-doc.txt
pip install .[doc]
```

From here, you can make changes to the documentation pages in `docs` and view how they appear by navigating to and hosting them locally:
Expand All @@ -107,4 +107,4 @@ mkdocs gh-deploy

## Changing dependencies

Is as the development process moves forward you find you need to add a new dependency, just add it to the relevant section of the `pyproject.toml` file and then run `pip-compile` as required to regenerate the different `requirements.txt` files. Read the [`pip-tools` documentation](https://pip-tools.readthedocs.io/en/latest/) for more information on the process.
Is as the development process moves forward you find you need to add a new dependency, just add it to the relevant section of the `pyproject.toml` file.
84 changes: 0 additions & 84 deletions requirements-demos.txt

This file was deleted.

140 changes: 0 additions & 140 deletions requirements-dev.txt

This file was deleted.

Loading

0 comments on commit 89d0ca2

Please sign in to comment.