Skip to content

Commit

Permalink
Added optional packages to pytoml and changed documentation for insta…
Browse files Browse the repository at this point in the history
…llation of the optional packages.
  • Loading branch information
mrosskopf committed Oct 10, 2024
1 parent 9396bd5 commit da0a9e8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ test a decent chunk of the complicated part of it and thus should always work.
## Linting

To adhere to the style guide and avoid silly errors always make sure `black` and
`flake8` pass (`pip install flake8 black`).
`flake8` pass (`pip install DUG-Seis[linting]`).

Just run the following in the `DUGSeis` source code directory:

Expand All @@ -92,7 +92,7 @@ The documentation resides in the `docs` directory. It depends on the following p
* `sphinx-book-theme`
* `myst-parser`

Once these are installed, just change to the docs directory and execute
Once these are installed (`pip install DUG-Seis[docsbuild]`), just change to the docs directory and execute

```bash
make html
Expand Down
11 changes: 11 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@ dependencies = [
"tqdm",
]

[project.optional-dependencies]
linting = [
"black",
"flake8",
]
docsbuild = [
"sphinx",
"sphinx-book-theme",
"myst-parser",
]

[project.urls]
Homepage = "https://dugseis.readthedocs.io"
Documentation = "https://dugseis.readthedocs.io"
Expand Down

0 comments on commit da0a9e8

Please sign in to comment.