Skip to content

Commit

Permalink
Updated doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
tlhr committed Sep 4, 2023
1 parent cf82f4e commit bd929a9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ conda activate maize
pip install -e ./
```

The first step will install maize (see the [maize documentation](https://molecularai.github.io/maize/quickstart.html#installation) for more information) and all required dependencies. If you plan on developing, you should use `env-dev.yml` instead.
The first step will install maize (see the [maize documentation](https://molecularai.github.io/maize/docs/quickstart.html#installation) for more information) and all required dependencies. If you plan on developing, you should use `env-dev.yml` instead.

Usage
-----
Expand All @@ -28,7 +28,7 @@ See the [**documentation**](https://molecularai.github.io/maize-contrib/index.ht

Development
-----------
Follow the development guidelines for [maize](https://molecularai.github.io/maize/development.html).
Follow the development guidelines for [maize](https://molecularai.github.io/maize/docs/development.html).

Because this is a namespace package, some development tools (especially linters) can have problems. I have switched from [pylint](https://pylint.readthedocs.io/en/latest/) to [ruff](https://beta.ruff.rs/docs/) which seems to handle these environments with no problems. For [mypy](https://mypy.readthedocs.io/en/stable/) it is important to specify `MYPY_PATH` and `explicit-package-bases` (see also [this issue](https://github.com/python/mypy/issues/8944)). If you're using VSCode, you will want to point `Pylance` to both the `maize` **and** `maize-contrib` package directories, or it will be unable to find `utilities` subpackages.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ maize-contrib
:maxdepth: 1
:caption: Core

Steps <https://molecularai.github.io/maize/steps>
Steps <https://molecularai.github.io/maize/docs/steps>
Maize <https://molecularai.github.io/maize>

Installation
Expand Down

0 comments on commit bd929a9

Please sign in to comment.