-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #78 from jpolz/sphinx_docs
Sphinx docs
- Loading branch information
Showing
9 changed files
with
65 additions
and
138 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -1,37 +1,29 @@ | ||
pycomlink.io package | ||
<<<<<<< HEAD | ||
IO | ||
==================== | ||
|
||
Submodules | ||
---------- | ||
|
||
pycomlink.io.cmlh5\_to\_xarray module | ||
------------------------------------- | ||
cmlh5\_to\_xarray | ||
----------------- | ||
|
||
.. automodule:: pycomlink.io.cmlh5_to_xarray | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.io.csv module | ||
----------------------- | ||
csv | ||
--- | ||
|
||
.. automodule:: pycomlink.io.csv | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.io.examples module | ||
---------------------------- | ||
|
||
.. automodule:: pycomlink.io.examples | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
.. ifconfig:: internal | ||
|
||
Module contents | ||
--------------- | ||
examples | ||
---------------------------- | ||
|
||
.. automodule:: pycomlink.io | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
.. automodule:: pycomlink.io.examples | ||
: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 |
---|---|---|
@@ -1,61 +1,47 @@ | ||
pycomlink.processing package | ||
Processing | ||
============================ | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
pycomlink.processing.wet_dry | ||
|
||
Submodules | ||
---------- | ||
wet_dry <pycomlink.processing.wet_dry> | ||
|
||
pycomlink.processing.baseline module | ||
baseline | ||
------------------------------------ | ||
|
||
.. automodule:: pycomlink.processing.baseline | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.processing.k\_R\_relation module | ||
k\_R\_relation | ||
------------------------------------------ | ||
|
||
.. automodule:: pycomlink.processing.k_R_relation | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.processing.min\_max module | ||
min\_max | ||
------------------------------------ | ||
|
||
.. automodule:: pycomlink.processing.min_max | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.processing.wet\_antenna module | ||
wet\_antenna | ||
---------------------------------------- | ||
|
||
.. automodule:: pycomlink.processing.wet_antenna | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.processing.xarray\_wrapper module | ||
xarray\_wrapper | ||
------------------------------------------- | ||
|
||
.. automodule:: pycomlink.processing.xarray_wrapper | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pycomlink.processing | ||
: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 |
---|---|---|
@@ -1,29 +1,18 @@ | ||
pycomlink.processing.wet\_dry package | ||
===================================== | ||
wet\_dry | ||
======== | ||
|
||
Submodules | ||
---------- | ||
|
||
pycomlink.processing.wet\_dry.cnn module | ||
cnn | ||
---------------------------------------- | ||
|
||
.. automodule:: pycomlink.processing.wet_dry.cnn | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.processing.wet\_dry.stft module | ||
stft | ||
----------------------------------------- | ||
|
||
.. automodule:: pycomlink.processing.wet_dry.stft | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pycomlink.processing.wet_dry | ||
: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 |
---|---|---|
@@ -1,24 +1,12 @@ | ||
pycomlink package | ||
================= | ||
|
||
Subpackages | ||
----------- | ||
pycomlink | ||
========= | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
pycomlink.io | ||
pycomlink.processing | ||
pycomlink.spatial | ||
pycomlink.tests | ||
pycomlink.util | ||
pycomlink.validation | ||
pycomlink.vis | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pycomlink | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
IO <pycomlink.io> | ||
Processing <pycomlink.processing> | ||
Spatial <pycomlink.spatial> | ||
Util <pycomlink.util> | ||
Validation <pycomlink.validation> | ||
Visualisation <pycomlink.vis> |
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 |
---|---|---|
@@ -1,45 +1,34 @@ | ||
pycomlink.spatial package | ||
Spatial | ||
========================= | ||
|
||
Submodules | ||
---------- | ||
|
||
pycomlink.spatial.coverage module | ||
coverage | ||
--------------------------------- | ||
|
||
.. automodule:: pycomlink.spatial.coverage | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.spatial.helper module | ||
helper | ||
------------------------------- | ||
|
||
.. automodule:: pycomlink.spatial.helper | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.spatial.idw module | ||
idw | ||
---------------------------- | ||
|
||
.. automodule:: pycomlink.spatial.idw | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.spatial.interpolator module | ||
interpolator | ||
------------------------------------- | ||
|
||
.. automodule:: pycomlink.spatial.interpolator | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pycomlink.spatial | ||
: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 |
---|---|---|
@@ -1,29 +1,18 @@ | ||
pycomlink.util package | ||
Util | ||
====================== | ||
|
||
Submodules | ||
---------- | ||
|
||
pycomlink.util.maintenance module | ||
maintenance | ||
--------------------------------- | ||
|
||
.. automodule:: pycomlink.util.maintenance | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.util.temporal module | ||
temporal | ||
------------------------------ | ||
|
||
.. automodule:: pycomlink.util.temporal | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pycomlink.util | ||
: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 |
---|---|---|
@@ -1,29 +1,18 @@ | ||
pycomlink.validation package | ||
Validation | ||
============================ | ||
|
||
Submodules | ||
---------- | ||
|
||
pycomlink.validation.stats module | ||
stats | ||
--------------------------------- | ||
|
||
.. automodule:: pycomlink.validation.stats | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.validation.validator module | ||
validator | ||
------------------------------------- | ||
|
||
.. automodule:: pycomlink.validation.validator | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pycomlink.validation | ||
: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 |
---|---|---|
@@ -1,29 +1,18 @@ | ||
pycomlink.vis package | ||
Visualisation | ||
===================== | ||
|
||
Submodules | ||
---------- | ||
|
||
pycomlink.vis.interactive\_maps module | ||
interactive\_maps | ||
-------------------------------------- | ||
|
||
.. automodule:: pycomlink.vis.interactive_maps | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
pycomlink.vis.maps module | ||
maps | ||
------------------------- | ||
|
||
.. automodule:: pycomlink.vis.maps | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: pycomlink.vis | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |