summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/vocoder
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
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')
-rw-r--r--docs/sphinx/source/vocoder/blks.rst19
-rw-r--r--docs/sphinx/source/vocoder/index.rst26
2 files changed, 0 insertions, 45 deletions
diff --git a/docs/sphinx/source/vocoder/blks.rst b/docs/sphinx/source/vocoder/blks.rst
deleted file mode 100644
index ea20bc44be..0000000000
--- a/docs/sphinx/source/vocoder/blks.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-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
diff --git a/docs/sphinx/source/vocoder/index.rst b/docs/sphinx/source/vocoder/index.rst
deleted file mode 100644
index 2e31809958..0000000000
--- a/docs/sphinx/source/vocoder/index.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-gnuradio.vocoder
-================
-
-.. automodule:: gnuradio.vocoder
-
-.. autosummary::
- :nosignatures:
-
- gnuradio.vocoder.alaw_decode_bs
- gnuradio.vocoder.alaw_encode_sb
- gnuradio.vocoder.codec2_decode_ps
- gnuradio.vocoder.codec2_encode_sp
- gnuradio.vocoder.cvsd_decode_bf
- gnuradio.vocoder.cvsd_decode_bs
- gnuradio.vocoder.cvsd_encode_fb
- gnuradio.vocoder.cvsd_encode_sb
- gnuradio.vocoder.g721_decode_bs
- gnuradio.vocoder.g721_encode_sb
- gnuradio.vocoder.g723_24_decode_bs
- gnuradio.vocoder.g723_24_encode_sb
- gnuradio.vocoder.g723_40_decode_bs
- gnuradio.vocoder.g723_40_encode_sb
- gnuradio.vocoder.gsm_fr_decode_ps
- gnuradio.vocoder.gsm_fr_encode_sp
- gnuradio.vocoder.ulaw_decode_bs
- gnuradio.vocoder.ulaw_encode_sb