From da0a9e80ecc31f3787798128f3365b7847696cd2 Mon Sep 17 00:00:00 2001 From: mrosskopf Date: Thu, 10 Oct 2024 10:40:55 +0200 Subject: [PATCH] Added optional packages to pytoml and changed documentation for installation of the optional packages. --- docs/development.md | 4 ++-- pyproject.toml | 11 +++++++++++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/development.md b/docs/development.md index c021c80..eeb396d 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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: @@ -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 diff --git a/pyproject.toml b/pyproject.toml index e43cefb..a900675 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"