Merge branch 'main' into fix-sphinx-structure

.circleci/config.yml

@@ -68,32 +68,6 @@ jobs:
           name: Flake8
           command: flake8 pyfar
 
-  test_examples:
-    parameters:
-      version:
-        description: "version tag"
-        default: "latest"
-        type: string
-    executor:
-      name: python-docker
-      version: <<parameters.version>>
-
-    steps:
-      - checkout
-      - run:
-          name: Install System Dependencies
-          command: sudo apt-get update && sudo apt-get install -y libsndfile1
-      - python/install-packages:
-          pkg-manager: pip
-          # app-dir: ~/project/package-directory/  # If you're requirements.txt isn't in the root directory.
-          pip-dependency-file: requirements_dev.txt
-      - run:
-          name: Examples
-          command: |
-            pip install astroid
-            pip install -e .
-            pytest --nbmake examples/*.ipynb
-
   test_documentation_build:
     parameters:
       version:
@@ -168,14 +142,6 @@ workflows:
           requires:
             - build_and_test
 
-      - test_examples:
-          matrix:
-            parameters:
-              version:
-                - "3.9"
-          requires:
-            - build_and_test
-
       - test_documentation_build:
           matrix:
             parameters:
@@ -219,20 +185,6 @@ workflows:
             tags:
               only: /^v[0-9]+(\.[0-9]+)*$/
 
-      - test_examples:
-          matrix:
-            parameters:
-              version:
-                - "3.9"
-          requires:
-            - build_and_test
-          filters:
-            branches:
-              ignore: /.*/
-            # only act on version tags
-            tags:
-              only: /^v[0-9]+(\.[0-9]+)*$/
-
       - test_documentation_build:
           matrix:
             parameters:
@@ -255,7 +207,6 @@ workflows:
           requires:
             - build_and_test
             - flake
-            - test_examples
             - test_documentation_build
           filters:
             branches:

.github/workflows/create_issue_if_coockiecutter.yml

@@ -0,0 +1,25 @@
+on:
+  pull_request:
+    types: [ labeled ]
+name: Create issue if pr gets a cookiecutter label
+jobs:
+  stuff:
+    permissions:
+      contents: read
+      issues: write
+    name: create issue
+    environment: test
+    if: github.event.label.name == 'cookiecutter'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          repository: 'pyfar/cookiecutter-pypackage'
+      - uses: dacbd/create-issue-action@v2
+        with:
+          title: ${{ github.event.pull_request.title  }}
+          token: ${{ secrets.cookiecutter_PAT }}
+          owner: pyfar
+          repo: cookiecutter-pypackage
+          body: |
+            apply changes from https://github.com/${{ github.repository }}/pull/${{ github.event.number }}

CONTRIBUTING.rst

@@ -244,7 +244,7 @@ A reminder for the maintainers on how to deploy.
 
 - Commit all changes to develop
 - Update HISTORY.rst in develop
-- Check if examples/pyfar_demo.ipynb needs to be updated
+- Check if gallery needs to be updated
 - Merge develop into main
 
 Switch to main and run::
@@ -255,6 +255,6 @@ $ git push --follow-tags
 The testing platform will then deploy to PyPI if tests pass.
 
 - merge main back into develop
-- check `binder`_
+- check gallery in `binder`_
 
-.. _binder: https://mybinder.org/v2/gh/pyfar/pyfar/main?filepath=examples%2Fpyfar_demo.ipynb
+.. _binder: https://mybinder.org/v2/gh/pyfar/gallery/main?filepath=docs/gallery

README.rst

@@ -10,7 +10,7 @@ pyfar
 .. image:: https://circleci.com/gh/pyfar/pyfar.svg?style=shield
     :target: https://circleci.com/gh/pyfar/pyfar
 .. image:: https://mybinder.org/badge_logo.svg
-    :target: https://mybinder.org/v2/gh/pyfar/pyfar/main?filepath=examples%2Fpyfar_demo.ipynb
+    :target: https://mybinder.org/v2/gh/pyfar/gallery/main?filepath=docs/gallery
 
 
 The python package for acoustics research (pyfar) offers classes to store
@@ -20,9 +20,9 @@ functions for digital audio signal processing.
 Getting Started
 ===============
 
-Check out the `examples notebook`_ for a tour of the most important pyfar
-functionality and `read the docs`_ for the complete documentation. Packages
-related to pyfar are listed at `pyfar.org`_.
+Check out `pyfar.org`_ for a tour through the pyfar
+universe, including complete documentation of this package and
+the other packages.
 
 Installation
 ============
@@ -44,7 +44,6 @@ Refer to the `contribution guidelines`_ for more information.
 
 
 .. _contribution guidelines: https://github.com/pyfar/pyfar/blob/develop/CONTRIBUTING.rst
-.. _examples notebook: https://mybinder.org/v2/gh/pyfar/pyfar/main?filepath=examples%2Fpyfar_demo.ipynb
 .. _pyfar.org: https://pyfar.org
 .. _read the docs: https://pyfar.readthedocs.io/en/latest
 .. _SoundFile: https://pysoundfile.readthedocs.io/en/latest/