diff options
author | Tom Rondeau <tom@trondeau.com> | 2015-08-17 13:02:35 -0400 |
---|---|---|
committer | Tom Rondeau <tom@trondeau.com> | 2015-08-17 14:37:25 -0400 |
commit | c0d72bb7eed0aafc82762db7cd9a498eadf8b2b9 (patch) | |
tree | 85828bd9415b6bb4334f34d0d51cc68a36064d2a /docs/sphinx/source/uhd.rst | |
parent | dff90672879bf1ed9d3e083ba236fdd6ce29e168 (diff) |
docs: Reviving Python manual.
I'd like to only produce a single manual, and the Sphinx docs take too
much manual labor to keep up-to-date. Still, there is a lot of useful
tools and classes only in Python that need to be exposed in a manual,
so this is the quickest way to get there.
This flattens the sphinx documentation structure so each component has
a <component>_blocks.rst where the actual GNU Radio blocks are managed
and a <component>.rst for any other non-block or Python-only code
(hier_block2, functions, and classes).
The new flattened file structure should make it easier to update, but
the index.rst should have some work done to make structure information
better.
Diffstat (limited to 'docs/sphinx/source/uhd.rst')
-rw-r--r-- | docs/sphinx/source/uhd.rst | 16 |
1 files changed, 1 insertions, 15 deletions
diff --git a/docs/sphinx/source/uhd.rst b/docs/sphinx/source/uhd.rst index 1f381e23b9..a9669622c6 100644 --- a/docs/sphinx/source/uhd.rst +++ b/docs/sphinx/source/uhd.rst @@ -1,18 +1,4 @@ gnuradio.uhd ============ -.. automodule:: gnuradio.uhd - -.. autoblock:: gnuradio.uhd.usrp_sink -.. autoblock:: gnuradio.uhd.usrp_source -.. autoblock:: 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 - - +.. autoclass:: gnuradio.uhd.usrp_block |