diff options
author | Tom Rondeau <tom@trondeau.com> | 2015-08-17 13:02:35 -0400 |
---|---|---|
committer | Tom Rondeau <tom@trondeau.com> | 2015-08-17 14:37:25 -0400 |
commit | c0d72bb7eed0aafc82762db7cd9a498eadf8b2b9 (patch) | |
tree | 85828bd9415b6bb4334f34d0d51cc68a36064d2a /docs/sphinx/source/trellis/index.rst | |
parent | dff90672879bf1ed9d3e083ba236fdd6ce29e168 (diff) |
docs: Reviving Python manual.
I'd like to only produce a single manual, and the Sphinx docs take too
much manual labor to keep up-to-date. Still, there is a lot of useful
tools and classes only in Python that need to be exposed in a manual,
so this is the quickest way to get there.
This flattens the sphinx documentation structure so each component has
a <component>_blocks.rst where the actual GNU Radio blocks are managed
and a <component>.rst for any other non-block or Python-only code
(hier_block2, functions, and classes).
The new flattened file structure should make it easier to update, but
the index.rst should have some work done to make structure information
better.
Diffstat (limited to 'docs/sphinx/source/trellis/index.rst')
-rw-r--r-- | docs/sphinx/source/trellis/index.rst | 90 |
1 files changed, 0 insertions, 90 deletions
diff --git a/docs/sphinx/source/trellis/index.rst b/docs/sphinx/source/trellis/index.rst deleted file mode 100644 index be929e971c..0000000000 --- a/docs/sphinx/source/trellis/index.rst +++ /dev/null @@ -1,90 +0,0 @@ -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 - - |