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/channels.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/channels.rst')
-rw-r--r-- | docs/sphinx/source/channels.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/sphinx/source/channels.rst b/docs/sphinx/source/channels.rst index 4013b57938..cd2fb368b2 100644 --- a/docs/sphinx/source/channels.rst +++ b/docs/sphinx/source/channels.rst @@ -1,8 +1,12 @@ gnuradio.channels ================= -.. automodule:: gnuradio.channels - -.. autoblock:: gnuradio.channels.channel_model -.. autoblock:: gnuradio.channels.fading_model - +.. autoclass:: gnuradio.channels.amp_bal +.. autoclass:: gnuradio.channels.conj_fs_iqcorr +.. autoclass:: gnuradio.channels.distortion_2_gen +.. autoclass:: gnuradio.channels.distortion_3_gen +.. autoclass:: gnuradio.channels.impairments +.. autoclass:: gnuradio.channels.iqbal_gen +.. autoclass:: gnuradio.channels.phase_bal +.. autoclass:: gnuradio.channels.phase_noise_gen +.. autoclass:: gnuradio.channels.quantizer |