Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sneakers-the-rat committed Nov 5, 2024
1 parent 7e7df34 commit b1ae405
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
13 changes: 8 additions & 5 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,15 @@ sphinx:
# - pdf

# Optionally declare the Python requirements required to build your docs

build:
os: ubuntu-22.04
tools:
python: "3.12"
jobs:
post_create_environment:
- pip install poetry
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --extras docs

python:
install:
- method: pip
path: .
extra_requirements:
- docs
4 changes: 2 additions & 2 deletions docs/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ cd miniscope-io
pip install .
```

Or poetry:
Or pdm:
```bash
git clone https://github.com/Aharoni-Lab/miniscope-io
cd miniscope-io
poetry install
pdm install
```


Expand Down
6 changes: 3 additions & 3 deletions docs/meta/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ arbitrary and expansive power)

## Development Environment

Install using the `dev` extra, which should have all other extras in it
Install using the `all` extra, which should have all other extras in it

```shell
poetry install --extras dev
pdm install --with all
# or
pip install '.[dev]'
pip install '.[all]'
```

### Linting
Expand Down

0 comments on commit b1ae405

Please sign in to comment.