summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-03-18 17:38:06 -0400
committerTom Rondeau <trondeau@vt.edu>2013-03-18 17:38:06 -0400
commit04682315bf151fb2c7c24673676cd8e07ab5fe2e (patch)
treebfa4a5157719b134adc5f6f3783f790220ae2f6b /docs
parent78527080d5cfcc611646d4694ecb9a026b343652 (diff)
parent3206f12930a131914ca2c0d15969c54d8dee5775 (diff)
Merge branch 'next' of gnuradio.org:gnuradio into next
Conflicts: gr-digital/examples/ofdm/ofdm_bugsquatch.py gr-digital/include/digital/scale_tags.h gr-digital/include/digital/tagged_stream_check.h gr-digital/include/digital/ts_insert_zeros_cc.h gr-digital/python/qa_ofdm_sync_sc_cfb.py 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')
-rw-r--r--docs/sphinx/gnuradio_sphinx.py27
-rw-r--r--docs/sphinx/source/index.rst13
-rw-r--r--docs/sphinx/source/uhd.rst18
3 files changed, 57 insertions, 1 deletions
diff --git a/docs/sphinx/gnuradio_sphinx.py b/docs/sphinx/gnuradio_sphinx.py
index 9955bf7317..f1e16481ba 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..4211eeab11 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>
+Hardware 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..d9ecf3a519
--- /dev/null
+++ b/docs/sphinx/source/uhd.rst
@@ -0,0 +1,18 @@
+gnuradio.uhd
+============
+
+.. automodule:: gnuradio.uhd
+
+.. autooldblock:: gnuradio.uhd.usrp_sink
+.. autooldblock:: gnuradio.uhd.usrp_source
+.. autooldblock:: gnuradio.uhd.amsg_source
+.. autoclass:: gnuradio.uhd.stream_cmd_t
+.. autoclass:: gnuradio.uhd.time_spec_t
+.. autoclass:: gnuradio.uhd.meta_range_t
+.. autoclass:: gnuradio.uhd.stream_args_t
+.. autoclass:: gnuradio.uhd.device_addr_t
+.. autoclass:: gnuradio.uhd.tune_request_t
+.. autoclass:: gnuradio.uhd.tune_result_t
+.. autoclass:: gnuradio.uhd.sensor_value_t
+
+