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

Merged
merged 22 commits into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
35c4edc
move information from concepts to coordinates class
f-brinkmann Apr 20, 2024
dc73012
remove audio concepts and link to gallery instead
f-brinkmann Apr 20, 2024
8e658bd
remove arithmetics concepts and link to gallery instead
f-brinkmann Apr 20, 2024
138c0c4
remove fft concepts and link to gallery instead
f-brinkmann Apr 20, 2024
57e4004
remove filter examples and link to gallery instead
f-brinkmann Apr 20, 2024
0498351
remove filter type examples and link to gallery instead
f-brinkmann Apr 20, 2024
a253798
remove plotting examples and link to gallery instead
f-brinkmann Apr 20, 2024
e6e59a8
fix typos discovered in review
f-brinkmann Apr 22, 2024
0b6da5d
Merge branch 'main' into documentation/remove_concepts
f-brinkmann Apr 26, 2024
128ca42
fix merge conflicts
f-brinkmann Apr 26, 2024
9f3871e
fix broken links in coordinates table
f-brinkmann Apr 26, 2024
04bfd4f
fix confusion with coordinate names and ranges
f-brinkmann Apr 26, 2024
e880f35
replace gallery inks by intersphinx definitions
ahms5 Apr 29, 2024
8945651
fix flake8
ahms5 Apr 29, 2024
4a3bd2c
update according to mberz
f-brinkmann May 3, 2024
946af37
remove links to notebook section explaining cshape, caxis, and cdim
f-brinkmann May 3, 2024
0b8206b
remove duplicate documentation
f-brinkmann May 16, 2024
33e52eb
Merge branch 'main' into documentation/remove_concepts
f-brinkmann Jun 4, 2024
a2b003c
move links to gallery from function docstrings to module docstrings
f-brinkmann Jun 4, 2024
eb40049
add link to Coordinates notebook
f-brinkmann Jun 4, 2024
623f17e
update according to review from ahms5
f-brinkmann Jun 5, 2024
8940929
Merge branch 'main' into documentation/remove_concepts
f-brinkmann Jun 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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
Original file line number Diff line number Diff line change
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)
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. include:: header.rst
.. include:: header.rst
6 changes: 0 additions & 6 deletions docs/modules/pyfar.dsp.filter.rst
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ pyfar
:caption: Documentation
:maxdepth: 2

concepts
classes
modules

Expand Down
Loading