summaryrefslogtreecommitdiff
path: root/docs/sphinx
diff options
context:
space:
mode:
authorJohnathan Corgan <johnathan@corganlabs.com>2013-03-18 08:52:10 -0700
committerJohnathan Corgan <johnathan@corganlabs.com>2013-03-18 08:52:10 -0700
commit9aeaa4744a70605a0fb49ec1bc897e1b7dba19d9 (patch)
treeac289e8635a5b36a9674505a7ad9341a10774043 /docs/sphinx
parent7774331476979a530288eb8217d19f8f7af64ed1 (diff)
parent456790ef73c859c10bca0a1d18da7d00aaed47f0 (diff)
Merge branch 'maint'
Diffstat (limited to 'docs/sphinx')
-rw-r--r--docs/sphinx/gnuradio_sphinx.py27
-rw-r--r--docs/sphinx/source/index.rst13
-rw-r--r--docs/sphinx/source/uhd.rst9
3 files changed, 48 insertions, 1 deletions
diff --git a/docs/sphinx/gnuradio_sphinx.py b/docs/sphinx/gnuradio_sphinx.py
index e8ca867f8c..06a3150c49 100644
--- a/docs/sphinx/gnuradio_sphinx.py
+++ b/docs/sphinx/gnuradio_sphinx.py
@@ -107,7 +107,32 @@ common_block_members =[
'to_basic_block',
'unique_id',
'make',
- ]
+ 'alias',
+ 'is_set_max_noutput_items',
+ 'max_noutput_items',
+ 'max_output_buffer',
+ 'message_ports_in',
+ 'message_ports_out',
+ 'min_output_buffer',
+ 'pc_input_buffers_full',
+ 'pc_input_buffers_full_var',
+ 'pc_noutput_items',
+ 'pc_noutput_items_var',
+ 'pc_nproduced',
+ 'pc_nproduced_var',
+ 'pc_output_buffers_full',
+ 'pc_output_buffers_full_var',
+ 'pc_work_time',
+ 'pc_work_time_var',
+ 'processor_affinity',
+ 'set_block_alias',
+ 'set_max_noutput_items',
+ 'unset_max_noutput_items',
+ 'set_max_output_buffer',
+ 'set_min_output_buffer',
+ 'set_processor_affinity',
+ 'symbol_name',
+ 'unset_processor_affinity', ]
class OldBlockDocumenter(FunctionDocumenter):
"""
diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst
index 38d859aafd..783b5af7e7 100644
--- a/docs/sphinx/source/index.rst
+++ b/docs/sphinx/source/index.rst
@@ -38,6 +38,19 @@ Core Framework
gnuradio.qtgui <qtgui/index>
gnuradio.wxgui <wxgui/index>
+Harware Interfaces
+------------------
+
+.. autosummary::
+ :nosignatures:
+
+ gnuradio.uhd
+
+.. toctree::
+ :hidden:
+
+ gnuradio.uhd <uhd>
+
Utilities
---------
diff --git a/docs/sphinx/source/uhd.rst b/docs/sphinx/source/uhd.rst
new file mode 100644
index 0000000000..92f4bdc8c2
--- /dev/null
+++ b/docs/sphinx/source/uhd.rst
@@ -0,0 +1,9 @@
+gnuradio.uhd
+============
+
+.. automodule:: gnuradio.uhd
+
+.. autooldblock:: gnuradio.uhd.usrp_sink
+.. autooldblock:: gnuradio.uhd.usrp_source
+.. autooldblock:: gnuradio.uhd.amsg_source
+