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 all 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.
226 changes: 0 additions & 226 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.
5 changes: 3 additions & 2 deletions docs/conf.py
Expand Up @@ -90,7 +90,8 @@
'numpy': ('https://numpy.org/doc/stable/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/', None),
'matplotlib': ('https://matplotlib.org/stable/', None),
'spharpy': ('https://spharpy.readthedocs.io/en/stable/', None)
'spharpy': ('https://spharpy.readthedocs.io/en/stable/', None),
'gallery': ('https://pyfar-gallery.readthedocs.io/en/latest/', None),
}

# -- Options for HTML output -------------------------------------------------
Expand Down Expand Up @@ -161,6 +162,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)
1 change: 0 additions & 1 deletion docs/index.rst
@@ -1,2 +1 @@

.. include:: header.rst
6 changes: 0 additions & 6 deletions docs/modules/pyfar.dsp.filter.rst
@@ -1,12 +1,6 @@
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.

.. automodule:: pyfar.dsp.filter
:members:
:undoc-members:
Expand Down
1 change: 0 additions & 1 deletion docs/pyfar.rst
Expand Up @@ -12,7 +12,6 @@ pyfar
:caption: Documentation
:maxdepth: 2

concepts
classes
modules

Expand Down