summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/vocoder_blocks.rst
diff options
context:
space:
mode:
authorTom Rondeau <tom@trondeau.com>2015-08-17 13:02:35 -0400
committerTom Rondeau <tom@trondeau.com>2015-08-17 14:37:25 -0400
commitc0d72bb7eed0aafc82762db7cd9a498eadf8b2b9 (patch)
tree85828bd9415b6bb4334f34d0d51cc68a36064d2a /docs/sphinx/source/vocoder_blocks.rst
parentdff90672879bf1ed9d3e083ba236fdd6ce29e168 (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/vocoder_blocks.rst')
-rw-r--r--docs/sphinx/source/vocoder_blocks.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/sphinx/source/vocoder_blocks.rst b/docs/sphinx/source/vocoder_blocks.rst
new file mode 100644
index 0000000000..ab8e5f650f
--- /dev/null
+++ b/docs/sphinx/source/vocoder_blocks.rst
@@ -0,0 +1,21 @@
+gnuradio.vocoder
+================
+
+.. automodule:: gnuradio.vocoder
+
+.. autoblock:: gnuradio.vocoder.alaw_decode_bs
+.. autoblock:: gnuradio.vocoder.alaw_encode_sb
+.. autoblock:: gnuradio.vocoder.codec2_decode_ps
+.. autoblock:: gnuradio.vocoder.codec2_encode_sp
+.. autoblock:: gnuradio.vocoder.cvsd_decode_bs
+.. autoblock:: gnuradio.vocoder.cvsd_encode_sb
+.. autoblock:: gnuradio.vocoder.g721_decode_bs
+.. autoblock:: gnuradio.vocoder.g721_encode_sb
+.. autoblock:: gnuradio.vocoder.g723_24_decode_bs
+.. autoblock:: gnuradio.vocoder.g723_24_encode_sb
+.. autoblock:: gnuradio.vocoder.g723_40_decode_bs
+.. autoblock:: gnuradio.vocoder.g723_40_encode_sb
+.. autoblock:: gnuradio.vocoder.gsm_fr_decode_ps
+.. autoblock:: gnuradio.vocoder.gsm_fr_encode_sp
+.. autoblock:: gnuradio.vocoder.ulaw_decode_bs
+.. autoblock:: gnuradio.vocoder.ulaw_encode_sb