From 0a4a01a1068faa7239305d2bd67b341f407590e4 Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Sun, 17 Mar 2013 22:30:20 -0700
Subject: docs: Adding gr-uhd to sphinx docs.
---
docs/sphinx/source/index.rst | 13 +++++++++++++
docs/sphinx/source/uhd.rst | 9 +++++++++
2 files changed, 22 insertions(+)
create mode 100644 docs/sphinx/source/uhd.rst
(limited to 'docs/sphinx')
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
+
--
cgit v1.2.3
From 456790ef73c859c10bca0a1d18da7d00aaed47f0 Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Sun, 17 Mar 2013 22:40:15 -0700
Subject: sphinx docs: Added additional block function names to blacklist so
that they are not displayed for every block.
---
docs/sphinx/gnuradio_sphinx.py | 27 ++++++++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
(limited to 'docs/sphinx')
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):
"""
--
cgit v1.2.3
From be043a9cf70b285c98254b40228ef161896d3862 Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Mon, 18 Mar 2013 11:11:54 -0700
Subject: sphinx docs: Adding more classes to uhd sphinx docs.
---
docs/sphinx/source/index.rst | 2 +-
docs/sphinx/source/uhd.rst | 9 +++++++++
2 files changed, 10 insertions(+), 1 deletion(-)
(limited to 'docs/sphinx')
diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst
index 783b5af7e7..eafebc8d08 100644
--- a/docs/sphinx/source/index.rst
+++ b/docs/sphinx/source/index.rst
@@ -38,7 +38,7 @@ Core Framework
gnuradio.qtgui <qtgui/index>
gnuradio.wxgui <wxgui/index>
-Harware Interfaces
+Hardware Interfaces
------------------
.. autosummary::
diff --git a/docs/sphinx/source/uhd.rst b/docs/sphinx/source/uhd.rst
index 92f4bdc8c2..d9ecf3a519 100644
--- a/docs/sphinx/source/uhd.rst
+++ b/docs/sphinx/source/uhd.rst
@@ -6,4 +6,13 @@ 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
+
--
cgit v1.2.3