summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/fft.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/fft.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/fft.rst')
-rw-r--r--docs/sphinx/source/fft.rst29
1 files changed, 1 insertions, 28 deletions
diff --git a/docs/sphinx/source/fft.rst b/docs/sphinx/source/fft.rst
index 2db3d1f5cb..563a5c898f 100644
--- a/docs/sphinx/source/fft.rst
+++ b/docs/sphinx/source/fft.rst
@@ -1,31 +1,4 @@
gnuradio.fft
============
-.. automodule:: gnuradio.fft
-
-.. autoblock:: gnuradio.fft.fft_vcc
-.. autoblock:: gnuradio.fft.fft_vfc
-.. autoblock:: gnuradio.fft.goertzel_fc
-
-gnuradio.fft.window
-===================
-
-.. automodule:: gnuradio.fft.window
-
-.. autofunction:: gnuradio.fft.window.bartlett
-.. autofunction:: gnuradio.fft.window.blackman2
-.. autofunction:: gnuradio.fft.window.blackman3
-.. autofunction:: gnuradio.fft.window.blackman4
-.. autofunction:: gnuradio.fft.window.blackmanharris
-.. autofunction:: gnuradio.fft.window.coswindow
-.. autofunction:: gnuradio.fft.window.exponential
-.. autofunction:: gnuradio.fft.window.flattop
-.. autofunction:: gnuradio.fft.window.hamming
-.. autofunction:: gnuradio.fft.window.hanning
-.. autofunction:: gnuradio.fft.window.kaiser
-.. autofunction:: gnuradio.fft.window.nuttall
-.. autofunction:: gnuradio.fft.window.nuttall_cfd
-.. autofunction:: gnuradio.fft.window.parzen
-.. autofunction:: gnuradio.fft.window.rectangular
-.. autofunction:: gnuradio.fft.window.riemann
-.. autofunction:: gnuradio.fft.window.welch
+.. autoclass:: gnuradio.fft.window