Skip to content

Commit

Permalink
Restructure module documents for more clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
nocarryr committed May 3, 2018
1 parent 86fd6f5 commit 3e811e2
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 23 deletions.
2 changes: 1 addition & 1 deletion doc/source/rtlsdr.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
rtlsdr module
==============
=============

.. automodule:: rtlsdr.rtlsdr
:members:
Expand Down
7 changes: 2 additions & 5 deletions doc/source/rtlsdraio.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
rtlsdraio module
================

.. autoclass:: rtlsdr.rtlsdraio.RtlSdrAio
:members:
.. automodule:: rtlsdr.rtlsdraio
:members: RtlSdrAio, AsyncCallbackIter
:show-inheritance:

.. autoclass:: rtlsdr.rtlsdraio.AsyncCallbackIter
:members:
24 changes: 7 additions & 17 deletions doc/source/rtlsdrtcp.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
rtlsdr\.rtlsdrtcp package
=========================

Submodules
----------
.. automodule:: rtlsdr.rtlsdrtcp

rtlsdr\.rtlsdrtcp\.base module
------------------------------
rtlsdr\.rtlsdrtcp\.server module
--------------------------------

.. automodule:: rtlsdr.rtlsdrtcp.base
.. automodule:: rtlsdr.rtlsdrtcp.server
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -20,19 +19,10 @@ rtlsdr\.rtlsdrtcp\.client module
:undoc-members:
:show-inheritance:

rtlsdr\.rtlsdrtcp\.server module
--------------------------------

.. automodule:: rtlsdr.rtlsdrtcp.server
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------
rtlsdr\.rtlsdrtcp\.base module
------------------------------

.. automodule:: rtlsdr.rtlsdrtcp
.. automodule:: rtlsdr.rtlsdrtcp.base
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 3e811e2

Please sign in to comment.