From bcc78ba2cd5f0f254cd90ffeea49a5b4e16c13fd Mon Sep 17 00:00:00 2001 From: Stephan Heunis Date: Mon, 6 Nov 2023 14:19:54 +0100 Subject: [PATCH 1/6] Add sphinx_copybutton extension to allow copying code in docs Mirrors https://github.com/datalad/datalad-extension-template/pull/88 --- docs/source/conf.py | 1 + setup.cfg | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 83e12455..c99208d8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -69,6 +69,7 @@ 'sphinx.ext.inheritance_diagram', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', + 'sphinx_copybutton', ] # for the module reference diff --git a/setup.cfg b/setup.cfg index 6296a06f..0616ed9e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -30,6 +30,7 @@ devel = coverage sphinx sphinx-rtd-theme + sphinx-copybutton [options.packages.find] # do not ship the build helpers From 4f55615ae022efc0b7c1e4d01ee1ddff5a43bf37 Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Mon, 9 Oct 2023 10:30:54 +0200 Subject: [PATCH 2/6] add comment what dependabot action does fixes #55 --- .github/dependabot.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index aa807cd2..7d3e0391 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,3 +1,4 @@ +# This action keeps the versions of all github actions up-to-date version: 2 updates: - package-ecosystem: github-actions From e4c62ecadb38e02b9c3d41bfc6200a5a6e9bae87 Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Mon, 9 Oct 2023 09:48:59 +0200 Subject: [PATCH 3/6] Remove outdated comment on Appveyor bug it was fixed in https://github.com/appveyor/ci/issues/3580 --- .appveyor.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.appveyor.yml b/.appveyor.yml index 706375f2..157bfc9e 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -155,9 +155,7 @@ install: # Missing system software - sh: "[ -n \"$INSTALL_SYSPKGS\" ] && ( [ \"x${APPVEYOR_BUILD_WORKER_IMAGE}\" = \"xmacOS\" ] && brew install -q ${INSTALL_SYSPKGS} || { sudo apt-get update -y && sudo apt-get install --no-install-recommends -y ${INSTALL_SYSPKGS}; } ) || true" # If a particular Python version is requested, use env setup (using the - # appveyor provided environments/installation). Note, these are broken - # on the ubuntu images - # https://help.appveyor.com/discussions/problems/28217-appveyor-ubunu-image-with-python3-lzma-module + # appveyor provided environments/installation). # Otherwise create a venv using the default Python 3, to enable uniform # use of python/pip executables below - sh: "[ \"x$PY\" != x ] && . ${HOME}/venv${PY}/bin/activate || python3 -m venv ${HOME}/dlvenv && . ${HOME}/dlvenv/bin/activate; ln -s \"$VIRTUAL_ENV\" \"${HOME}/VENV\"" From f043a7cf509d6be0ebc5265c02d61b06f641c56c Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Mon, 9 Oct 2023 09:29:56 +0200 Subject: [PATCH 4/6] Use standard configuration filename Accoding to https://docs.readthedocs.io/en/stable/config-file/index.html, it is .readthedocs.yaml, not readthedocs.yml. Fixes #79 --- readthedocs.yml => .readthedocs.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename readthedocs.yml => .readthedocs.yaml (100%) diff --git a/readthedocs.yml b/.readthedocs.yaml similarity index 100% rename from readthedocs.yml rename to .readthedocs.yaml From 58cabef4a8de41f066a0df542e6055dd4aa17c1f Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 27 Jan 2023 20:44:24 -0500 Subject: [PATCH 5/6] Add .codespellrc with our skips etc --- .codespellrc | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..4cf7f14b --- /dev/null +++ b/.codespellrc @@ -0,0 +1,4 @@ +[codespell] +skip = .venv,venvs,.git,build,*.egg-info,*.lock,.asv,.mypy_cache,.tox,fixtures,_version.py,*.pem +# ignore-words-list = +# exclude-file = From 8338303b9f5fe65641463a2fff0c1aa45f146f9b Mon Sep 17 00:00:00 2001 From: Stephan Heunis Date: Mon, 6 Nov 2023 14:54:31 +0100 Subject: [PATCH 6/6] git ignore .idea/ and venvs/ Based on https://github.com/datalad/datalad-extension-template/pull/58/commits/a5d7a1b938ebe05417b8211a7b786b40bef1ae63 --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 38321b50..9c707e32 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,5 @@ docs/build docs/source/generated build # manpage +.idea/ +venvs/