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.

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

Documentation/remove concepts #591

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
18 changes: 0 additions & 18 deletions docs/concepts.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/concepts/pyfar.arithmetic_operations.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/concepts/pyfar.audio_classes.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/concepts/pyfar.coordinates.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/concepts/pyfar.fft.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/concepts/pyfar.filter_classes.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/concepts/pyfar.filter_types.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/concepts/pyfar.plot.rst

This file was deleted.

57 changes: 0 additions & 57 deletions docs/concepts/resources/fft_norms.py

This file was deleted.

Binary file removed docs/concepts/resources/fft_norms_examples.png
Binary file not shown.
225 changes: 0 additions & 225 deletions docs/concepts/resources/filter_types.py

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file removed docs/concepts/resources/filter_types_crossover.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/concepts/resources/filter_types_standard.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -129,6 +129,6 @@

# write shortcuts to sphinx readable format
_, shortcuts = pyfar.plot.shortcuts(show=False, report=True, layout="sphinx")
shortcuts_path = os.path.join("concepts", "resources", "plot_shortcuts.rst")
shortcuts_path = os.path.join("resources", "plot_shortcuts.rst")
with open(shortcuts_path, "w") as f_id:
f_id.writelines(shortcuts)
5 changes: 0 additions & 5 deletions docs/index.rst
Expand Up @@ -13,11 +13,6 @@ Getting Started
Documentation
=============

.. toctree::
:maxdepth: 2

concepts

.. toctree::
:maxdepth: 2

Expand Down
12 changes: 7 additions & 5 deletions docs/modules/pyfar.dsp.filter.rst
@@ -1,11 +1,13 @@
pyfar.dsp.filter
================

The following documents the pyfar filters. Visit
:py:mod:`filter types <pyfar._concepts.filter_types>` for an introduction of
the different filters and
:py:mod:`filter classes <pyfar._concepts.filter_classes>` for more information
on pyfar filter objects.
The following documents the pyfar filters. Visit the
`filter types <https://pyfar-gallery.readthedocs.io/en/latest/gallery/
interactive/pyfar_filter_types.html>`_ for an overview of
the different filters and the
`filtering examples <https://pyfar-gallery.readthedocs.io/en/latest/
gallery/interactive/pyfar_filtering.html>`_ for more information
on using pyfar filter objects.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following documents the pyfar filters. Visit the
`filter types <https://pyfar-gallery.readthedocs.io/en/latest/gallery/
interactive/pyfar_filter_types.html>`_ for an overview of
the different filters and the
`filtering examples <https://pyfar-gallery.readthedocs.io/en/latest/
gallery/interactive/pyfar_filtering.html>`_ for more information
on using pyfar filter objects.
The following documents the pyfar filters. Visit the
:doc:`gallery:gallery/interactive/fast_fourier_transform` for an overview of
the different filters and the :doc:`gallery:gallery/interactive/pyfar_filtering`
for more information
on using pyfar filter objects.

we need to add

    'gallery': ('https://pyfar-gallery.readthedocs.io/en/latest/', None),

to the config.py in intersphinx_mapping then we can use intersphinx to generate the links


.. automodule:: pyfar.dsp.filter
:members:
Expand Down