diff options
Diffstat (limited to 'docs/sphinx/source/trellis')
-rw-r--r-- | docs/sphinx/source/trellis/blks.rst | 62 | ||||
-rw-r--r-- | docs/sphinx/source/trellis/index.rst | 90 | ||||
-rw-r--r-- | docs/sphinx/source/trellis/objs.rst | 5 |
3 files changed, 157 insertions, 0 deletions
diff --git a/docs/sphinx/source/trellis/blks.rst b/docs/sphinx/source/trellis/blks.rst new file mode 100644 index 000000000..d82319bad --- /dev/null +++ b/docs/sphinx/source/trellis/blks.rst @@ -0,0 +1,62 @@ +gnuradio.trellis: Signal Processing Blocks +========================================== + +.. autooldblock:: gnuradio.trellis.constellation_metrics_cf +.. autooldblock:: gnuradio.trellis.encoder_bb +.. autooldblock:: gnuradio.trellis.encoder_bi +.. autooldblock:: gnuradio.trellis.encoder_bs +.. autooldblock:: gnuradio.trellis.encoder_ii +.. autooldblock:: gnuradio.trellis.encoder_si +.. autooldblock:: gnuradio.trellis.encoder_ss +.. autooldblock:: gnuradio.trellis.metrics_c +.. autooldblock:: gnuradio.trellis.metrics_f +.. autooldblock:: gnuradio.trellis.metrics_i +.. autooldblock:: gnuradio.trellis.metrics_s +.. autooldblock:: gnuradio.trellis.pccc_decoder_b +.. autooldblock:: gnuradio.trellis.pccc_decoder_combined_cb +.. autooldblock:: gnuradio.trellis.pccc_decoder_combined_ci +.. autooldblock:: gnuradio.trellis.pccc_decoder_combined_cs +.. autooldblock:: gnuradio.trellis.pccc_decoder_combined_fb +.. autooldblock:: gnuradio.trellis.pccc_decoder_combined_fi +.. autooldblock:: gnuradio.trellis.pccc_decoder_combined_fs +.. autooldblock:: gnuradio.trellis.pccc_decoder_i +.. autooldblock:: gnuradio.trellis.pccc_decoder_s +.. autooldblock:: gnuradio.trellis.pccc_encoder_bb +.. autooldblock:: gnuradio.trellis.pccc_encoder_bi +.. autooldblock:: gnuradio.trellis.pccc_encoder_bs +.. autooldblock:: gnuradio.trellis.pccc_encoder_ii +.. autooldblock:: gnuradio.trellis.pccc_encoder_si +.. autooldblock:: gnuradio.trellis.pccc_encoder_ss +.. autooldblock:: gnuradio.trellis.permutation +.. autooldblock:: gnuradio.trellis.sccc_decoder_b +.. autooldblock:: gnuradio.trellis.sccc_decoder_combined_cb +.. autooldblock:: gnuradio.trellis.sccc_decoder_combined_ci +.. autooldblock:: gnuradio.trellis.sccc_decoder_combined_cs +.. autooldblock:: gnuradio.trellis.sccc_decoder_combined_fb +.. autooldblock:: gnuradio.trellis.sccc_decoder_combined_fi +.. autooldblock:: gnuradio.trellis.sccc_decoder_combined_fs +.. autooldblock:: gnuradio.trellis.sccc_decoder_i +.. autooldblock:: gnuradio.trellis.sccc_decoder_s +.. autooldblock:: gnuradio.trellis.sccc_encoder_bb +.. autooldblock:: gnuradio.trellis.sccc_encoder_bi +.. autooldblock:: gnuradio.trellis.sccc_encoder_bs +.. autooldblock:: gnuradio.trellis.sccc_encoder_ii +.. autooldblock:: gnuradio.trellis.sccc_encoder_si +.. autooldblock:: gnuradio.trellis.sccc_encoder_ss +.. autooldblock:: gnuradio.trellis.siso_combined_f +.. autooldblock:: gnuradio.trellis.siso_f +.. autooldblock:: gnuradio.trellis.viterbi_b +.. autooldblock:: gnuradio.trellis.viterbi_combined_cb +.. autooldblock:: gnuradio.trellis.viterbi_combined_ci +.. autooldblock:: gnuradio.trellis.viterbi_combined_cs +.. autooldblock:: gnuradio.trellis.viterbi_combined_fb +.. autooldblock:: gnuradio.trellis.viterbi_combined_fi +.. autooldblock:: gnuradio.trellis.viterbi_combined_fs +.. autooldblock:: gnuradio.trellis.viterbi_combined_ib +.. autooldblock:: gnuradio.trellis.viterbi_combined_ii +.. autooldblock:: gnuradio.trellis.viterbi_combined_is +.. autooldblock:: gnuradio.trellis.viterbi_combined_sb +.. autooldblock:: gnuradio.trellis.viterbi_combined_si +.. autooldblock:: gnuradio.trellis.viterbi_combined_ss +.. autooldblock:: gnuradio.trellis.viterbi_i +.. autooldblock:: gnuradio.trellis.viterbi_s diff --git a/docs/sphinx/source/trellis/index.rst b/docs/sphinx/source/trellis/index.rst new file mode 100644 index 000000000..8a451a913 --- /dev/null +++ b/docs/sphinx/source/trellis/index.rst @@ -0,0 +1,90 @@ +gnuradio.trellis +================ + +.. automodule:: gnuradio.trellis + +Object Classes +-------------- + +.. autosummary:: + :nosignatures: + + gnuradio.trellis.fsm + gnuradio.trellis.interleaver + +Signal Processing Blocks +------------------------ + +.. autosummary:: + :nosignatures: + + gnuradio.trellis.constellation_metrics_cf + gnuradio.trellis.encoder_bb + gnuradio.trellis.encoder_bi + gnuradio.trellis.encoder_bs + gnuradio.trellis.encoder_ii + gnuradio.trellis.encoder_si + gnuradio.trellis.encoder_ss + gnuradio.trellis.metrics_c + gnuradio.trellis.metrics_f + gnuradio.trellis.metrics_i + gnuradio.trellis.metrics_s + gnuradio.trellis.pccc_decoder_b + gnuradio.trellis.pccc_decoder_combined_cb + gnuradio.trellis.pccc_decoder_combined_ci + gnuradio.trellis.pccc_decoder_combined_cs + gnuradio.trellis.pccc_decoder_combined_fb + gnuradio.trellis.pccc_decoder_combined_fi + gnuradio.trellis.pccc_decoder_combined_fs + gnuradio.trellis.pccc_decoder_i + gnuradio.trellis.pccc_decoder_s + gnuradio.trellis.pccc_encoder_bb + gnuradio.trellis.pccc_encoder_bi + gnuradio.trellis.pccc_encoder_bs + gnuradio.trellis.pccc_encoder_ii + gnuradio.trellis.pccc_encoder_si + gnuradio.trellis.pccc_encoder_ss + gnuradio.trellis.permutation + gnuradio.trellis.sccc_decoder_b + gnuradio.trellis.sccc_decoder_combined_cb + gnuradio.trellis.sccc_decoder_combined_ci + gnuradio.trellis.sccc_decoder_combined_cs + gnuradio.trellis.sccc_decoder_combined_fb + gnuradio.trellis.sccc_decoder_combined_fi + gnuradio.trellis.sccc_decoder_combined_fs + gnuradio.trellis.sccc_decoder_i + gnuradio.trellis.sccc_decoder_s + gnuradio.trellis.sccc_encoder_bb + gnuradio.trellis.sccc_encoder_bi + gnuradio.trellis.sccc_encoder_bs + gnuradio.trellis.sccc_encoder_ii + gnuradio.trellis.sccc_encoder_si + gnuradio.trellis.sccc_encoder_ss + gnuradio.trellis.siso_combined_f + gnuradio.trellis.siso_f + gnuradio.trellis.viterbi_b + gnuradio.trellis.viterbi_combined_cb + gnuradio.trellis.viterbi_combined_ci + gnuradio.trellis.viterbi_combined_cs + gnuradio.trellis.viterbi_combined_fb + gnuradio.trellis.viterbi_combined_fi + gnuradio.trellis.viterbi_combined_fs + gnuradio.trellis.viterbi_combined_ib + gnuradio.trellis.viterbi_combined_ii + gnuradio.trellis.viterbi_combined_is + gnuradio.trellis.viterbi_combined_sb + gnuradio.trellis.viterbi_combined_si + gnuradio.trellis.viterbi_combined_ss + gnuradio.trellis.viterbi_i + gnuradio.trellis.viterbi_s + +Constants +--------- + +.. autosummary:: + :nosignatures: + + gnuradio.trellis.TRELLIS_MIN_SUM + gnuradio.trellis.TRELLIS_SUM_PRODUCT + + diff --git a/docs/sphinx/source/trellis/objs.rst b/docs/sphinx/source/trellis/objs.rst new file mode 100644 index 000000000..b3a4b7a4a --- /dev/null +++ b/docs/sphinx/source/trellis/objs.rst @@ -0,0 +1,5 @@ +gnuradio.trellis: Object Classes +-------------------------------- + +.. autoclass:: gnuradio.trellis.fsm +.. autoclass:: gnuradio.trellis.interleaver |