Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove-examples #565

Closed
wants to merge 4 commits into from
Closed

Remove-examples #565

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93e9d13
remove pyfar demo
ahms5 Mar 28, 2024
0fbc5fd
link to gallery in readme
ahms5 Mar 28, 2024
10774d3
changes in contribution
ahms5 Mar 28, 2024
b96c64d
Update README.rst
ahms5 Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand All @@ -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
9 changes: 4 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 the `pyfar.org`_ for a tour trought the pyfar
ahms5 marked this conversation as resolved.
Show resolved Hide resolved
universe, including complete documentation of this package and
the other packages.

Installation
============
Expand All @@ -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/
Expand Down