Skip to content

V1 api docs #64

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

Merged
mberz merged 10 commits into from
Aug 15, 2025
Merged

V1 api docs #64

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
93bf005
API reference adjusted for develop_1.0.0
sbch22 Aug 8, 2025
d5ca6e9
API reference adjusted for develop_1.0.0
sbch22 Aug 8, 2025
f5561a0
API reference adjusted for develop_1.0.0
sbch22 Aug 8, 2025
525a20e
Apply suggestions from code review
sbch22 Aug 12, 2025
23b8235
API reference import-path like reference added for all submodules
sbch22 Aug 12, 2025
81b2c52
dsp.py dcostring modication to new hierarchy
sbch22 Aug 12, 2025
f23096c
edc.py docstring modification to new hierarchy
sbch22 Aug 12, 2025
8fc85a2
added structure for analytic submodule
sbch22 Aug 12, 2025
e18c355
Update docs/modules/analytic.rst
sbch22 Aug 13, 2025
02b3368
pyrato.analytic structure adjusted
sbch22 Aug 13, 2025
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
5 changes: 4 additions & 1 deletion docs/api_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,8 @@ Modules
.. toctree::
:maxdepth: 1

modules/pyrato
modules/analytic
modules/dsp
modules/edc
modules/parameters
modules/parametric
6 changes: 3 additions & 3 deletions docs/modules/pyrato.rst → docs/modules/dsp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pyrato
======
dsp
Comment thread
sbch22 marked this conversation as resolved.
Outdated
========

.. automodule:: pyrato
.. automodule:: pyrato.dsp
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/modules/edc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
edc
Comment thread
sbch22 marked this conversation as resolved.
Outdated
========

.. automodule:: pyrato.edc
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/modules/parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
parameters
Comment thread
sbch22 marked this conversation as resolved.
Outdated
========

.. automodule:: pyrato.parameters
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/modules/parametric.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
parametric
Comment thread
sbch22 marked this conversation as resolved.
Outdated
========

.. automodule:: pyrato.parametric
:members:
:undoc-members:
:show-inheritance:
Loading