From b5d078f37468e2da11d696bf88ae6b252ca1c678 Mon Sep 17 00:00:00 2001 From: Alessandro Candido Date: Fri, 19 May 2023 11:23:03 +0200 Subject: [PATCH 1/3] Use Poetry for RTD docs installation --- .readthedocs.yaml | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b7b7465fc..7b5c39c8d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,18 +1,18 @@ -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required version: 2 -# Set the version of Python and other tools you might need build: - os: ubuntu-20.04 # is required: see https://github.com/readthedocs/readthedocs.org/issues/8912 + os: ubuntu-22.04 tools: python: "3.10" apt_packages: - graphviz + jobs: + post_create_environment: + - pip install poetry + - poetry config virtualenvs.create false + post_install: + - poetry install --with docs -# Build documentation in the docs/ directory with Sphinx sphinx: configuration: doc/source/conf.py @@ -20,12 +20,10 @@ sphinx: # formats: # - pdf -# Optionally set requirements required to build your docs python: install: - method: pip path: . extra_requirements: - - docs - mark - box From 3623ee32db40887e7f779c69302d4197e11c36ca Mon Sep 17 00:00:00 2001 From: Alessandro Candido Date: Fri, 19 May 2023 11:25:10 +0200 Subject: [PATCH 2/3] Drop docs extra --- pyproject.toml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 14dcfce4c..be99f5e8e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,11 +43,6 @@ scipy = "^1.10.1" PyYAML = "^6.0" lz4 = "^4.0.2" numba = "^0.57.0" -# docs dependencies (for readthedocs, https://github.com/readthedocs/readthedocs.org/issues/4912#issuecomment-664002569) -Sphinx = { version = "^4.3.2", optional = true } -sphinx-rtd-theme = { version = "^1.0.0", optional = true } -sphinxcontrib-bibtex = { version = "^2.4.1", optional = true } -nbsphinx = { version = "^0.8.8", optional = true } # ekomark banana-hep = { version = "^0.6.8", optional = true } sqlalchemy = { version = "^1.4.21", optional = true } @@ -86,7 +81,6 @@ virtualenv = "^20.13.2" devtools = "^0.10.0" [tool.poetry.extras] -docs = ["sphinx", "sphinx-rtd-theme", "sphinxcontrib-bibtex", "nbsphinx"] mark = ["banana-hep", "sqlalchemy", "pandas", "matplotlib"] box = ["rich"] From 44d0a94c0515aa7f978e7fdad113239bbc8921c6 Mon Sep 17 00:00:00 2001 From: Alessandro Candido Date: Fri, 19 May 2023 11:34:04 +0200 Subject: [PATCH 3/3] Make dev group mandatory --- pyproject.toml | 3 --- 1 file changed, 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index be99f5e8e..5ce374edb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -69,9 +69,6 @@ pytest-cov = "4.0.0" pytest-env = "^0.6.2" pylint = "^2.12.2" -[tool.poetry.group.dev] -optional = true - [tool.poetry.group.dev.dependencies] pdbpp = "^0.10.3" ipython = "^8.0"