summaryrefslogtreecommitdiff
path: root/docs/sphinx
diff options
context:
space:
mode:
authorBen Reynwar <ben@reynwar.net>2013-04-26 16:20:48 -0700
committerBen Reynwar <ben@reynwar.net>2013-04-26 16:20:48 -0700
commit009d47a2b6decdf2b434f517a7a14ba2a865f9ac (patch)
treef7075e9158b87d5a35939a3477447aa55d0a6a64 /docs/sphinx
parent6fc2fb2a1624a4b59de488e170ea9dbb81ba7649 (diff)
sphinx: Added sphinx source for gr-channels, gr-comedi, gr-fcd, gr-fec.
Diffstat (limited to 'docs/sphinx')
-rw-r--r--docs/sphinx/source/channels.rst8
-rw-r--r--docs/sphinx/source/comedi.rst8
-rw-r--r--docs/sphinx/source/fcd.rst7
-rw-r--r--docs/sphinx/source/fec.rst8
-rw-r--r--docs/sphinx/source/index.rst8
5 files changed, 39 insertions, 0 deletions
diff --git a/docs/sphinx/source/channels.rst b/docs/sphinx/source/channels.rst
new file mode 100644
index 0000000000..4013b57938
--- /dev/null
+++ b/docs/sphinx/source/channels.rst
@@ -0,0 +1,8 @@
+gnuradio.channels
+=================
+
+.. automodule:: gnuradio.channels
+
+.. autoblock:: gnuradio.channels.channel_model
+.. autoblock:: gnuradio.channels.fading_model
+
diff --git a/docs/sphinx/source/comedi.rst b/docs/sphinx/source/comedi.rst
new file mode 100644
index 0000000000..2bed3683a2
--- /dev/null
+++ b/docs/sphinx/source/comedi.rst
@@ -0,0 +1,8 @@
+gnuradio.comedi
+===============
+
+.. automodule:: gnuradio.comedi
+
+.. autoblock:: gnuradio.comedi.source_s
+.. autoblock:: gnuradio.comedi.sink_s
+
diff --git a/docs/sphinx/source/fcd.rst b/docs/sphinx/source/fcd.rst
new file mode 100644
index 0000000000..126ef9c916
--- /dev/null
+++ b/docs/sphinx/source/fcd.rst
@@ -0,0 +1,7 @@
+gnuradio.fcd
+============
+
+.. automodule:: gnuradio.fcd
+
+.. autoblock:: gnuradio.fcd.fcd_source_c
+
diff --git a/docs/sphinx/source/fec.rst b/docs/sphinx/source/fec.rst
new file mode 100644
index 0000000000..75de71911b
--- /dev/null
+++ b/docs/sphinx/source/fec.rst
@@ -0,0 +1,8 @@
+gnuradio.fec
+============
+
+.. automodule:: gnuradio.fec
+
+.. autoblock:: gnuradio.fec.decode_ccsds_27_fb
+.. autoblock:: gnuradio.fec.encode_ccsds_27_bb
+
diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst
index aea6f2dd6e..bb27d1a22e 100644
--- a/docs/sphinx/source/index.rst
+++ b/docs/sphinx/source/index.rst
@@ -14,6 +14,9 @@ Core Framework
gnuradio.analog
gnuradio.digital
gnuradio.audio
+ gnuradio.channels
+ gnuradio.comedi
+ gnuradio.fec
gnuradio.trellis
gnuradio.wavelet
gnuradio.fft
@@ -29,6 +32,9 @@ Core Framework
gnuradio.analog <analog/index>
gnuradio.digital <digital/index>
gnuradio.audio <audio/index>
+ gnuradio.channels <channels>
+ gnuradio.comedi <comedi>
+ gnuradio.fec <fec>
gnuradio.gr_unittest <gr_unittest/index>
gnuradio.trellis <trellis/index>
gnuradio.wavelet <wavelet>
@@ -43,11 +49,13 @@ Hardware Interfaces
:nosignatures:
gnuradio.uhd
+ gnuradio.fcd
.. toctree::
:hidden:
gnuradio.uhd <uhd>
+ gnuradio.fcd <fcd>
Utilities
---------