summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/atsc
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2012-09-06 12:01:23 -0400
committerTom Rondeau <trondeau@vt.edu>2012-09-06 12:01:23 -0400
commitc9dc582402d2551ead29a60256fdf64a1d43534c (patch)
tree4e9fe56c173a8e080c84c4c113a5ac5c5f1c236c /docs/sphinx/source/atsc
parent1300d48af4752037feac4fae7c3c64187cc0a5a8 (diff)
parenta4e2e8a9a2c8a6bbd6d676a17b0e2732e11af09f (diff)
Merge branch 'master' into gr_log
Conflicts: CMakeLists.txt cmake/Modules/GrMiscUtils.cmake docs/doxygen/other/build_guide.dox gnuradio-core/CMakeLists.txt gr-digital/lib/CMakeLists.txt
Diffstat (limited to 'docs/sphinx/source/atsc')
-rw-r--r--docs/sphinx/source/atsc/blks.rst20
-rw-r--r--docs/sphinx/source/atsc/index.rst62
2 files changed, 82 insertions, 0 deletions
diff --git a/docs/sphinx/source/atsc/blks.rst b/docs/sphinx/source/atsc/blks.rst
new file mode 100644
index 0000000000..6f51a22876
--- /dev/null
+++ b/docs/sphinx/source/atsc/blks.rst
@@ -0,0 +1,20 @@
+gnuradio.atsc: Signal Processing Blocks
+=======================================
+
+.. autooldblock:: gnuradio.atsc.bit_timing_loop
+.. autooldblock:: gnuradio.atsc.deinterleaver
+.. autooldblock:: gnuradio.atsc.depad
+.. autooldblock:: gnuradio.atsc.derandomizer
+.. autooldblock:: gnuradio.atsc.ds_to_softds
+.. autooldblock:: gnuradio.atsc.equalizer
+.. autooldblock:: gnuradio.atsc.field_sync_demux
+.. autooldblock:: gnuradio.atsc.field_sync_mux
+.. autooldblock:: gnuradio.atsc.fpll
+.. autooldblock:: gnuradio.atsc.fs_checker
+.. autooldblock:: gnuradio.atsc.interleaver
+.. autooldblock:: gnuradio.atsc.pad
+.. autooldblock:: gnuradio.atsc.randomizer
+.. autooldblock:: gnuradio.atsc.rs_decoder
+.. autooldblock:: gnuradio.atsc.rs_encoder
+.. autooldblock:: gnuradio.atsc.trellis_encoder
+.. autooldblock:: gnuradio.atsc.viterbi_decoder
diff --git a/docs/sphinx/source/atsc/index.rst b/docs/sphinx/source/atsc/index.rst
new file mode 100644
index 0000000000..2371f24569
--- /dev/null
+++ b/docs/sphinx/source/atsc/index.rst
@@ -0,0 +1,62 @@
+gnuradio.atsc
+=============
+
+.. automodule:: gnuradio.atsc
+
+Signal Processing Blocks
+------------------------
+
+.. autosummary::
+ :nosignatures:
+
+ gnuradio.atsc.bit_timing_loop
+ gnuradio.atsc.deinterleaver
+ gnuradio.atsc.depad
+ gnuradio.atsc.derandomizer
+ gnuradio.atsc.ds_to_softds
+ gnuradio.atsc.equalizer
+ gnuradio.atsc.field_sync_demux
+ gnuradio.atsc.field_sync_mux
+ gnuradio.atsc.fpll
+ gnuradio.atsc.fs_checker
+ gnuradio.atsc.interleaver
+ gnuradio.atsc.pad
+ gnuradio.atsc.randomizer
+ gnuradio.atsc.rs_decoder
+ gnuradio.atsc.rs_encoder
+ gnuradio.atsc.trellis_encoder
+ gnuradio.atsc.viterbi_decoder
+
+Constants
+---------
+
+.. autosummary::
+ :nosignatures:
+
+ gnuradio.atsc.ATSC_DATA_SEGMENT_LENGTH
+ gnuradio.atsc.ATSC_DATA_SEGMENT_RATE
+ gnuradio.atsc.ATSC_DSEGS_PER_FIELD
+ gnuradio.atsc.ATSC_MPEG_DATA_LENGTH
+ gnuradio.atsc.ATSC_MPEG_PKT_LENGTH
+ gnuradio.atsc.ATSC_MPEG_RS_ENCODED_LENGTH
+ gnuradio.atsc.ATSC_SYMBOL_RATE
+ gnuradio.atsc.MPEG_SYNC_BYTE
+ gnuradio.atsc.MPEG_TRANSPORT_ERROR_BIT
+
+Sizes
+---------
+
+.. autosummary::
+ :nosignatures:
+
+ gnuradio.atsc.sizeof_atsc_data_segment
+ gnuradio.atsc.sizeof_atsc_data_segment_pad
+ gnuradio.atsc.sizeof_atsc_mpeg_packet
+ gnuradio.atsc.sizeof_atsc_mpeg_packet_no_sync
+ gnuradio.atsc.sizeof_atsc_mpeg_packet_no_sync_pad
+ gnuradio.atsc.sizeof_atsc_mpeg_packet_pad
+ gnuradio.atsc.sizeof_atsc_mpeg_packet_rs_encoded
+ gnuradio.atsc.sizeof_atsc_mpeg_packet_rs_encoded_pad
+ gnuradio.atsc.sizeof_atsc_soft_data_segment
+ gnuradio.atsc.sizeof_atsc_soft_data_segment_pad
+