summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/optfir
diff options
context:
space:
mode:
authorManoj Gudi2013-10-07 20:19:55 +0530
committerManoj Gudi2013-10-07 20:20:35 +0530
commit1826d0763c8595997f5f4af1fdb0354e9c0998ad (patch)
treeacbd852cd5a1bf17241b1038b5e37a0e72e64612 /docs/sphinx/source/optfir
parent452defdb4a78e9e826740ddf4b9673e926c568a4 (diff)
parent24b640997ba7fee0c725e65f401f5cbebdab8d08 (diff)
downloadgnuradio-1826d0763c8595997f5f4af1fdb0354e9c0998ad.tar.gz
gnuradio-1826d0763c8595997f5f4af1fdb0354e9c0998ad.tar.bz2
gnuradio-1826d0763c8595997f5f4af1fdb0354e9c0998ad.zip
README change
Diffstat (limited to 'docs/sphinx/source/optfir')
-rw-r--r--docs/sphinx/source/optfir/detail.rst14
-rw-r--r--docs/sphinx/source/optfir/index.rst19
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/sphinx/source/optfir/detail.rst b/docs/sphinx/source/optfir/detail.rst
new file mode 100644
index 000000000..78807bee0
--- /dev/null
+++ b/docs/sphinx/source/optfir/detail.rst
@@ -0,0 +1,14 @@
+gnuradio.optfir
+===============
+
+.. autofunction:: gnuradio.optfir.band_pass
+.. autofunction:: gnuradio.optfir.band_reject
+.. autofunction:: gnuradio.optfir.bporder
+.. autofunction:: gnuradio.optfir.complex_band_pass
+.. autofunction:: gnuradio.optfir.high_pass
+.. autofunction:: gnuradio.optfir.low_pass
+.. autofunction:: gnuradio.optfir.lporder
+.. autofunction:: gnuradio.optfir.passband_ripple_to_dev
+.. autofunction:: gnuradio.optfir.remez
+.. autofunction:: gnuradio.optfir.remezord
+.. autofunction:: gnuradio.optfir.stopband_atten_to_dev
diff --git a/docs/sphinx/source/optfir/index.rst b/docs/sphinx/source/optfir/index.rst
new file mode 100644
index 000000000..f49b01a1f
--- /dev/null
+++ b/docs/sphinx/source/optfir/index.rst
@@ -0,0 +1,19 @@
+gnuradio.optfir
+===============
+
+.. automodule:: gnuradio.optfir
+
+.. autosummary::
+ :nosignatures:
+
+ gnuradio.optfir.band_pass
+ gnuradio.optfir.band_reject
+ gnuradio.optfir.bporder
+ gnuradio.optfir.complex_band_pass
+ gnuradio.optfir.high_pass
+ gnuradio.optfir.low_pass
+ gnuradio.optfir.lporder
+ gnuradio.optfir.passband_ripple_to_dev
+ gnuradio.optfir.remez
+ gnuradio.optfir.remezord
+ gnuradio.optfir.stopband_atten_to_dev