From 3c91b88af095c94ef9f91d4adf98655fae3ea2da Mon Sep 17 00:00:00 2001 From: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com> Date: Tue, 23 Jul 2024 14:00:34 -0400 Subject: [PATCH] disable numpydoc for now, fix tox --- {{cookiecutter.project_slug}}/Makefile | 2 +- .../environment-dev.yml | 2 +- {{cookiecutter.project_slug}}/pyproject.toml | 2 +- {{cookiecutter.project_slug}}/tox.ini | 16 +++++++--------- 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/{{cookiecutter.project_slug}}/Makefile b/{{cookiecutter.project_slug}}/Makefile index 773581dc1..ddbea6ebe 100644 --- a/{{cookiecutter.project_slug}}/Makefile +++ b/{{cookiecutter.project_slug}}/Makefile @@ -66,7 +66,7 @@ clean-test: ## remove test and coverage artifacts lint/flake8: ## check style with flake8 python -m ruff check src/{{ cookiecutter.project_slug }} tests python -m flake8 --config=.flake8 src/{{ cookiecutter.project_slug }} tests - python -m numpydoc --validate src/{{ cookiecutter.project_slug }} + # python -m numpydoc --validate src/{{ cookiecutter.project_slug }} {% if cookiecutter.use_black == 'y' -%} lint/black: ## check style with black diff --git a/{{cookiecutter.project_slug}}/environment-dev.yml b/{{cookiecutter.project_slug}}/environment-dev.yml index ed1e5d9ed..6420558ce 100644 --- a/{{cookiecutter.project_slug}}/environment-dev.yml +++ b/{{cookiecutter.project_slug}}/environment-dev.yml @@ -27,6 +27,6 @@ dependencies: - blackdoc ==0.3.9 - isort ==5.13.2 {%- endif %} - - numpydoc >=1.7.0 + # - numpydoc >=1.7.0 - pre-commit >=3.5.0 - ruff >=0.5.0 diff --git a/{{cookiecutter.project_slug}}/pyproject.toml b/{{cookiecutter.project_slug}}/pyproject.toml index 527c86fef..7b0a1e8b1 100644 --- a/{{cookiecutter.project_slug}}/pyproject.toml +++ b/{{cookiecutter.project_slug}}/pyproject.toml @@ -62,7 +62,7 @@ dev = [ "coverage >=7.5.0", "coveralls >=4.0.0", "mypy", - "numpydoc >=1.7.0", + # "numpydoc >=1.7.0", {%- if cookiecutter.use_pytest == 'y' %} "pytest >=8.2.2", "pytest-cov >=5.0.0", diff --git a/{{cookiecutter.project_slug}}/tox.ini b/{{cookiecutter.project_slug}}/tox.ini index 1874cbaec..e394adcdb 100644 --- a/{{cookiecutter.project_slug}}/tox.ini +++ b/{{cookiecutter.project_slug}}/tox.ini @@ -8,7 +8,7 @@ envlist = {%- endif %} coveralls requires = - flit ~= 3.9.0, + flit ~= 3.9.0 opts = --verbose @@ -23,7 +23,7 @@ deps = flake8 >=7.1.0 flake8-rst-docstrings >=0.3.0 ruff >=0.5.0 - numpydoc >=1.7.0 + ; numpydoc >=1.7.0 commands = make lint allowlist_externals = @@ -57,14 +57,12 @@ deps = commands_pre = pip list pip check -{%- if cookiecutter.use_pytest == 'y' %} + commands = + {% if cookiecutter.use_pytest == 'y' -%} pytest --cov - # Coveralls requires access to a repo token set in .coveralls.yml in order to report stats - coveralls: - coveralls -{% else -%} -commands = + {%- else -%} coverage run - # Coveralls requires access to a repo token set in .coveralls.yml in order to report stats + {%- endif %} + ; Coveralls requires access to a repo token set in .coveralls.yml in order to report stats coveralls: - coveralls -{% endif -%}