Adding sphinx documentation.

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..a2eda07d6
--- /dev/null
+++ b/docs/sphinx/source/trellis/blks.rst
@@ -0,0 +1,62 @@
+gnuradio.trellis: Signal Processing Blocks
+==========================================
+
+.. autoblock:: gnuradio.trellis.constellation_metrics_cf
+.. autoblock:: gnuradio.trellis.encoder_bb
+.. autoblock:: gnuradio.trellis.encoder_bi
+.. autoblock:: gnuradio.trellis.encoder_bs
+.. autoblock:: gnuradio.trellis.encoder_ii
+.. autoblock:: gnuradio.trellis.encoder_si
+.. autoblock:: gnuradio.trellis.encoder_ss
+.. autoblock:: gnuradio.trellis.metrics_c
+.. autoblock:: gnuradio.trellis.metrics_f
+.. autoblock:: gnuradio.trellis.metrics_i
+.. autoblock:: gnuradio.trellis.metrics_s
+.. autoblock:: gnuradio.trellis.pccc_decoder_b
+.. autoblock:: gnuradio.trellis.pccc_decoder_combined_cb
+.. autoblock:: gnuradio.trellis.pccc_decoder_combined_ci
+.. autoblock:: gnuradio.trellis.pccc_decoder_combined_cs
+.. autoblock:: gnuradio.trellis.pccc_decoder_combined_fb
+.. autoblock:: gnuradio.trellis.pccc_decoder_combined_fi
+.. autoblock:: gnuradio.trellis.pccc_decoder_combined_fs
+.. autoblock:: gnuradio.trellis.pccc_decoder_i
+.. autoblock:: gnuradio.trellis.pccc_decoder_s
+.. autoblock:: gnuradio.trellis.pccc_encoder_bb
+.. autoblock:: gnuradio.trellis.pccc_encoder_bi
+.. autoblock:: gnuradio.trellis.pccc_encoder_bs
+.. autoblock:: gnuradio.trellis.pccc_encoder_ii
+.. autoblock:: gnuradio.trellis.pccc_encoder_si
+.. autoblock:: gnuradio.trellis.pccc_encoder_ss
+.. autoblock:: gnuradio.trellis.permutation
+.. autoblock:: gnuradio.trellis.sccc_decoder_b
+.. autoblock:: gnuradio.trellis.sccc_decoder_combined_cb
+.. autoblock:: gnuradio.trellis.sccc_decoder_combined_ci
+.. autoblock:: gnuradio.trellis.sccc_decoder_combined_cs
+.. autoblock:: gnuradio.trellis.sccc_decoder_combined_fb
+.. autoblock:: gnuradio.trellis.sccc_decoder_combined_fi
+.. autoblock:: gnuradio.trellis.sccc_decoder_combined_fs
+.. autoblock:: gnuradio.trellis.sccc_decoder_i
+.. autoblock:: gnuradio.trellis.sccc_decoder_s
+.. autoblock:: gnuradio.trellis.sccc_encoder_bb
+.. autoblock:: gnuradio.trellis.sccc_encoder_bi
+.. autoblock:: gnuradio.trellis.sccc_encoder_bs
+.. autoblock:: gnuradio.trellis.sccc_encoder_ii
+.. autoblock:: gnuradio.trellis.sccc_encoder_si
+.. autoblock:: gnuradio.trellis.sccc_encoder_ss
+.. autoblock:: gnuradio.trellis.siso_combined_f
+.. autoblock:: gnuradio.trellis.siso_f
+.. autoblock:: gnuradio.trellis.viterbi_b
+.. autoblock:: gnuradio.trellis.viterbi_combined_cb
+.. autoblock:: gnuradio.trellis.viterbi_combined_ci
+.. autoblock:: gnuradio.trellis.viterbi_combined_cs
+.. autoblock:: gnuradio.trellis.viterbi_combined_fb
+.. autoblock:: gnuradio.trellis.viterbi_combined_fi
+.. autoblock:: gnuradio.trellis.viterbi_combined_fs
+.. autoblock:: gnuradio.trellis.viterbi_combined_ib
+.. autoblock:: gnuradio.trellis.viterbi_combined_ii
+.. autoblock:: gnuradio.trellis.viterbi_combined_is
+.. autoblock:: gnuradio.trellis.viterbi_combined_sb
+.. autoblock:: gnuradio.trellis.viterbi_combined_si
+.. autoblock:: gnuradio.trellis.viterbi_combined_ss
+.. autoblock:: gnuradio.trellis.viterbi_i
+.. autoblock:: 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