-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
use sphinx-apidoc rather than manual list of modules
this avoids missing modules in the documentation for each release, re-build the rst files by first deleting contents of /docs/source then running `sphinx-apidoc -o docs/source opensoundscape -T` from the root dir, and deleting the "opensoundscape packe" heading in /docs/source/opensoundscape.rst
- Loading branch information
Showing
7 changed files
with
354 additions
and
131 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
opensoundscape.localization package | ||
=================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
opensoundscape.localization.audiomoth\_sync module | ||
-------------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.localization.audiomoth_sync | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.localization.localization\_algorithms module | ||
----------------------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.localization.localization_algorithms | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.localization.position\_estimate module | ||
----------------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.localization.position_estimate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.localization.spatial\_event module | ||
------------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.localization.spatial_event | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.localization.synchronized\_recorder\_array module | ||
---------------------------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.localization.synchronized_recorder_array | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.localization.utils module | ||
---------------------------------------- | ||
|
||
.. automodule:: opensoundscape.localization.utils | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: opensoundscape.localization | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
opensoundscape.ml package | ||
========================= | ||
|
||
Submodules | ||
---------- | ||
|
||
opensoundscape.ml.bioacoustics\_model\_zoo module | ||
------------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.bioacoustics_model_zoo | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.cam module | ||
---------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.cam | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.cnn module | ||
---------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.cnn | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.cnn\_architectures module | ||
------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.cnn_architectures | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.dataloaders module | ||
------------------------------------ | ||
|
||
.. automodule:: opensoundscape.ml.dataloaders | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.datasets module | ||
--------------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.datasets | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.lightning module | ||
---------------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.lightning | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.loss module | ||
----------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.loss | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.safe\_dataset module | ||
-------------------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.safe_dataset | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.sampling module | ||
--------------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.sampling | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.shallow\_classifier module | ||
-------------------------------------------- | ||
|
||
.. automodule:: opensoundscape.ml.shallow_classifier | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
opensoundscape.ml.utils module | ||
------------------------------ | ||
|
||
.. automodule:: opensoundscape.ml.utils | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: opensoundscape.ml | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Oops, something went wrong.