summaryrefslogtreecommitdiff
path: root/docs/sphinx
diff options
context:
space:
mode:
authorJohnathan Corgan <johnathan@corganlabs.com>2013-03-18 09:10:18 -0700
committerJohnathan Corgan <johnathan@corganlabs.com>2013-03-18 09:22:19 -0700
commit113c4ef92819e703d24eb6a409751f2757635528 (patch)
tree38e42b254d9d9f4367a07ffc5f1452e43a54f7b7 /docs/sphinx
parentf15400470ce5cb68f5339ead7af726b8bbafd364 (diff)
parentc3d4fbf1809d6b3051a4c532d3d6bb5cadb3b6e3 (diff)
Merge branch 'master' into next
Conflicts: gr-digital/include/digital/CMakeLists.txt gr-digital/lib/CMakeLists.txt gr-digital/lib/scale_tags_impl.cc gr-digital/lib/tagged_stream_check_impl.cc gr-digital/lib/ts_insert_zeros_cc_impl.cc gr-digital/python/qa_scale_tags.py gr-digital/python/qa_ts_insert_zeros.py gr-digital/swig/digital_swig.i
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 988b6554c5..ea80abc230 100644
--- a/docs/sphinx/source/index.rst
+++ b/docs/sphinx/source/index.rst
@@ -32,6 +32,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
+