diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7aac66d7..f8abbb3b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,11 +12,11 @@ version: 2 # Set the version of Python and other tools you might need build: os: ubuntu-22.04 - tools: - python: "3.11" apt_packages: # graphviz is required for sphinx.ext.graphviz - graphviz + tools: + python: "3.12" # Build documentation in the docs/ directory with Sphinx sphinx: @@ -30,4 +30,7 @@ formats: # Optionally declare the Python requirements required to build your docs python: install: - - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: + - docs diff --git a/README.rst b/README.rst index 0b08cfa6..1791b0fc 100644 --- a/README.rst +++ b/README.rst @@ -60,9 +60,9 @@ Installation .. code-block:: console $ cd python4datascience-main - $ python3 -m venv . - $ . bin/activate - $ python -m pip install -r docs/requirements.txt + $ python3 -m venv .venv + $ . .venv/bin/activate + $ python -m pip install -e ".[dev]" #. Install the `Jupyter Notebook Extensions `_ Javascript and CSS diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index e9d3f27a..00000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# SPDX-FileCopyrightText: 2019 Veit Schiele -# -# SPDX-License-Identifier: BSD-3-Clause - -furo -ipython -ipywidgets -nbsphinx -sphinxcontrib-svg2pdfconverter -sphinxext-opengraph -# matplotlib is required for social cards -matplotlib -sphinx-copybutton -sphinx_inline_tabs -sphinx-lint diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..9c630bc9 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,41 @@ +[project] +name = "Python4DataScience" +version = "24.2.0" +authors = [ + { name="Veit Schiele", email="veit@cusy.io" }, +] +description = "Teaching materials for the cusy training courses on Python-based data science workflows: https://cusy.io/en/seminars" +readme = "README.rst" +requires-python = ">=3.9" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: BSD License", + "Operating System :: OS Independent", +] +dependencies = [] + +[project.optional-dependencies] +docs = [ + "furo", + "ipython", + "ipywidgets", + "nbsphinx", + "sphinxcontrib-svg2pdfconverter", + "sphinxext.opengraph", # matplotlib is required for social cards + "matplotlib", + "sphinx-copybutton", + "sphinx_inline_tabs", + "sphinx-lint", +] + +dev = [ + "Python4DataScience[docs]", + "pre-commit", +] + +[project.urls] +"Homepage" = "https://github.com/cusyio/Python4DataScience/" +"Bug Tracker" = "https://github.com/cusyio/Python4DataScience/issues" + +[tool.setuptools] +packages = []