From 264efd5f384f4c5d75625a8418fad2d91b60170a Mon Sep 17 00:00:00 2001 From: ddelange <14880945+ddelange@users.noreply.github.com> Date: Fri, 20 Oct 2023 06:54:55 +0200 Subject: [PATCH 1/3] :construction_worker: Fix readthedocs --- .readthedocs.yaml | 17 +++++++++++------ pyproject.toml | 2 +- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 83de6f4..db6b2a4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,6 +5,12 @@ # Required version: 2 +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py @@ -16,10 +22,9 @@ sphinx: # Optionally build your docs in additional formats such as PDF and ePub formats: all -# Optionally set the version of Python and requirements required to build your docs +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - version: 3.8 - install: - - method: pip - path: . - - requirements: requirements/docs.txt + install: + - requirements: requirements/docs.txt diff --git a/pyproject.toml b/pyproject.toml index ed19bdb..d0777f4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -60,7 +60,7 @@ addopts = "-s --strict-markers -vv --cache-clear --doctest-modules --cov=mapply [tool.ruff] select = ["ALL"] -ignore = ["D407", "E501", "ANN", "TRY003", "D203", "D213", "D100", "D104"] # ignores: D407 (we have google style docstrings), E501 (we have black), ANN (we have mypy), TRY003 (there is EM102), D203 (there is D211), D213 (there is D212), D100,D104 (we don't publish publick readthedocs) +ignore = ["D407", "E501", "ANN", "TRY003", "D203", "D213"] # ignores: D407 (we have google style docstrings), E501 (we have black), ANN (we have mypy), TRY003 (there is EM102), D203 (there is D211), D213 (there is D212) target-version = "py38" [tool.ruff.extend-per-file-ignores] From 2b9aa08e871f70d377d9e066689f869c0073392a Mon Sep 17 00:00:00 2001 From: ddelange <14880945+ddelange@users.noreply.github.com> Date: Fri, 20 Oct 2023 08:19:22 +0200 Subject: [PATCH 2/3] Fix install --- .readthedocs.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index db6b2a4..c38d0aa 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -26,5 +26,7 @@ formats: all # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - install: - - requirements: requirements/docs.txt + install: + - method: pip + path: . + - requirements: requirements/docs.txt From af1968b20b2eb804fa2bdc4ba5d1af43bfd7c639 Mon Sep 17 00:00:00 2001 From: ddelange <14880945+ddelange@users.noreply.github.com> Date: Fri, 20 Oct 2023 08:23:13 +0200 Subject: [PATCH 3/3] Make lint --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index d0777f4..a13abe5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -65,7 +65,7 @@ target-version = "py38" [tool.ruff.extend-per-file-ignores] "__init__.py" = ["E401", "E402"] -"tests/*.py" = ["S101"] +"**/tests/**/*.py" = ["S101", "D100", "D104"] [tool.ruff.isort] known-first-party = ["tests"]