From c0d72bb7eed0aafc82762db7cd9a498eadf8b2b9 Mon Sep 17 00:00:00 2001 From: Tom Rondeau <tom@trondeau.com> Date: Mon, 17 Aug 2015 13:02:35 -0400 Subject: 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. --- docs/sphinx/source/atsc/blks.rst | 20 ------------- docs/sphinx/source/atsc/index.rst | 62 --------------------------------------- 2 files changed, 82 deletions(-) delete mode 100644 docs/sphinx/source/atsc/blks.rst delete mode 100644 docs/sphinx/source/atsc/index.rst (limited to 'docs/sphinx/source/atsc') diff --git a/docs/sphinx/source/atsc/blks.rst b/docs/sphinx/source/atsc/blks.rst deleted file mode 100644 index 6f51a22876..0000000000 --- a/docs/sphinx/source/atsc/blks.rst +++ /dev/null @@ -1,20 +0,0 @@ -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 deleted file mode 100644 index a8a54ad337..0000000000 --- a/docs/sphinx/source/atsc/index.rst +++ /dev/null @@ -1,62 +0,0 @@ -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 - -- cgit v1.2.3