diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-04-27 15:56:00 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-04-27 15:56:00 -0700 |
| commit | 72948e9a4031f8d779a70f73e6e6a0014d1de326 (patch) | |
| tree | ef8ea31b6d053fa73db56c8f50f4d9bbadb78d53 /docs/sphinx/source/gr | |
| parent | 7ffda05db5aeb0bdd590a10b6d340fa49192b7fd (diff) | |
sphinx: Add start of pmt sphinx docs. Tidied gr sphinx docs.
Diffstat (limited to 'docs/sphinx/source/gr')
| -rw-r--r-- | docs/sphinx/source/gr/contents.rst (renamed from docs/sphinx/source/gr/misc.rst) | 19 | ||||
| -rw-r--r-- | docs/sphinx/source/gr/index.rst | 36 | ||||
| -rw-r--r-- | docs/sphinx/source/gr/internal.rst | 7 | ||||
| -rw-r--r-- | docs/sphinx/source/gr/top_block.rst | 7 |
4 files changed, 21 insertions, 48 deletions
diff --git a/docs/sphinx/source/gr/misc.rst b/docs/sphinx/source/gr/contents.rst index 013f3fc53d..a999a73ea8 100644 --- a/docs/sphinx/source/gr/misc.rst +++ b/docs/sphinx/source/gr/contents.rst @@ -1,11 +1,18 @@ -gnuradio.gr: Miscellaneous -========================== +gnuradio.gr +=========== -.. autofunction:: gnuradio.gr.feval_dd -.. autofunction:: gnuradio.gr.feval_cc -.. autofunction:: gnuradio.gr.feval_ll -.. autofunction:: gnuradio.gr.feval +.. autoclass:: gnuradio.gr.top_block +.. autoclass:: gnuradio.gr.hier_block2 +.. autofunction:: gnuradio.gr.block_detail +.. autofunction:: gnuradio.gr.buffer +.. autofunction:: gnuradio.gr.dispatcher +.. autofunction:: gnuradio.gr.single_threaded_scheduler .. autofunction:: gnuradio.gr.prefs .. autofunction:: gnuradio.gr.message .. autofunction:: gnuradio.gr.msg_queue .. autofunction:: gnuradio.gr.enable_realtime_scheduling +.. autofunction:: gnuradio.gr.feval_dd +.. autofunction:: gnuradio.gr.feval_cc +.. autofunction:: gnuradio.gr.feval_ll +.. autofunction:: gnuradio.gr.feval + diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst index cef9d560e2..7df7114340 100644 --- a/docs/sphinx/source/gr/index.rst +++ b/docs/sphinx/source/gr/index.rst @@ -3,41 +3,21 @@ gnuradio.gr .. automodule:: gnuradio.gr -Signal Processing Blocks ------------------------- - -Top Block and Hierarchical Block Base Classes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. autosummary:: :nosignatures: gnuradio.gr.top_block gnuradio.gr.hier_block2 - -Miscellaneous -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.gr.feval_dd - gnuradio.gr.feval_cc - gnuradio.gr.feval_ll - gnuradio.gr.feval - gnuradio.gr.prefs - gnuradio.gr.message - gnuradio.gr.msg_queue - gnuradio.gr.enable_realtime_scheduling - -Implementation Details ----------------------- - -.. autosummary:: - :nosignatures: - gnuradio.gr.block_detail gnuradio.gr.buffer gnuradio.gr.dispatcher gnuradio.gr.single_threaded_scheduler + gnuradio.gr.prefs + gnuradio.gr.message + gnuradio.gr.msg_queue + gnuradio.gr.enable_realtime_scheduling + gnuradio.gr.feval_dd + gnuradio.gr.feval_cc + gnuradio.gr.feval_ll + gnuradio.gr.feval diff --git a/docs/sphinx/source/gr/internal.rst b/docs/sphinx/source/gr/internal.rst deleted file mode 100644 index 4948b38d4d..0000000000 --- a/docs/sphinx/source/gr/internal.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Implementation Details -=================================== - -.. autofunction:: gnuradio.gr.block_detail -.. autofunction:: gnuradio.gr.buffer -.. autofunction:: gnuradio.gr.dispatcher -.. autofunction:: gnuradio.gr.single_threaded_scheduler diff --git a/docs/sphinx/source/gr/top_block.rst b/docs/sphinx/source/gr/top_block.rst deleted file mode 100644 index 3d4e9ef3d6..0000000000 --- a/docs/sphinx/source/gr/top_block.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Top Block and Hierarchical Block Base Classes -========================================================== - -.. autoclass:: gnuradio.gr.top_block - -.. autoclass:: gnuradio.gr.hier_block2 - |