summaryrefslogtreecommitdiff
path: root/docs/sphinx
diff options
context:
space:
mode:
authorJosh Blum2013-03-31 22:30:00 -0700
committerJosh Blum2013-03-31 22:30:00 -0700
commit993ff9e8c1050bad327041132828370986a72b28 (patch)
treee0c58a41a120b4da8b55f42099ccea8d5517019a /docs/sphinx
parent78ccc760124713a56c9c85729ac40844a97f0550 (diff)
parent78cd4026c0a9b902162e94905b60a9dd44a07bb7 (diff)
downloadgnuradio-993ff9e8c1050bad327041132828370986a72b28.tar.gz
gnuradio-993ff9e8c1050bad327041132828370986a72b28.tar.bz2
gnuradio-993ff9e8c1050bad327041132828370986a72b28.zip
Merge branch 'maint' into v3.6.4git_gras_support
Conflicts: gnuradio-core/src/lib/runtime/gr_block.cc gnuradio-core/src/lib/runtime/gr_block.h
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.rst18
3 files changed, 57 insertions, 1 deletions
diff --git a/docs/sphinx/gnuradio_sphinx.py b/docs/sphinx/gnuradio_sphinx.py
index e8ca867f8..06a3150c4 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 38d859aaf..eafebc8d0 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>
+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 000000000..d9ecf3a51
--- /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
+
+