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 | |
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')
106 files changed, 2463 insertions, 2435 deletions
diff --git a/docs/sphinx/source/analog.rst b/docs/sphinx/source/analog.rst new file mode 100644 index 0000000000..0bbaba6185 --- /dev/null +++ b/docs/sphinx/source/analog.rst @@ -0,0 +1,21 @@ +gnuradio.analog +=============== + +.. autoclass:: gnuradio.analog.cpm +.. autoclass:: gnuradio.analog.squelch_base_cc +.. autoclass:: gnuradio.analog.squelch_base_ff +.. autoclass:: gnuradio.analog.am_demod_cf +.. autoclass:: gnuradio.analog.demod_10k0a3e_cf +.. autoclass:: gnuradio.analog.fm_demod_cf +.. autoclass:: gnuradio.analog.demod_20k0f3e_cf +.. autoclass:: gnuradio.analog.demod_200kf3e_cf +.. autoclass:: gnuradio.analog.fm_deemph +.. autoclass:: gnuradio.analog.fm_preemph +.. autoclass:: gnuradio.analog.nbfm_rx +.. autoclass:: gnuradio.analog.nbfm_tx +.. autoclass:: gnuradio.analog.ctcss_gen_f +.. autoclass:: gnuradio.analog.standard_squelch +.. autoclass:: gnuradio.analog.wfm_rcv_fmdet +.. autoclass:: gnuradio.analog.wfm_rcv_pll +.. autoclass:: gnuradio.analog.wfm_rcv +.. autoclass:: gnuradio.analog.wfm_tx diff --git a/docs/sphinx/source/analog/get_blocks.py b/docs/sphinx/source/analog/get_blocks.py deleted file mode 100644 index f5fc902a8a..0000000000 --- a/docs/sphinx/source/analog/get_blocks.py +++ /dev/null @@ -1,106 +0,0 @@ -""" -This script regenerates the gnuradio.blocks sphinx source code. -""" - -from gnuradio import analog -import sys -import os - -doxyxml_location = os.path.abspath("../../../doxygen") -xml_location = os.path.abspath("../../../../build/docs/doxygen/xml/") -sys.path.append(doxyxml_location) - -from doxyxml import DoxyIndex, DoxyClass, DoxyFriend, DoxyFunction, DoxyFile, DoxyGroup -from doxyxml import DoxyOther, base - -class Block(object): - """ - Checks if doxyxml produced objects correspond to a new style - gnuradio block. - """ - - @classmethod - def includes(cls, item): - if not isinstance(item, DoxyClass): - return False - # Check for a parsing error. - if item.error(): - return False - is_a_block = item.has_member('make', DoxyFunction) and item.has_member('sptr', DoxyOther) - return is_a_block - -class Group(object): - """ - Checks if doxyxml produced objects correspond to a group. - """ - - @classmethod - def includes(cls, item): - if not isinstance(item, DoxyGroup): - return False - # Check for a parsing error. - if item.error(): - return False - return True - -def main(): - di = DoxyIndex(xml_location) - blocks = di.in_category(Block) - analog_blocks = [] - for block in blocks: - if block.name().startswith("gr::analog::"): - analog_blocks.append(block) - - all_grouped_blocks = [] - groups = di.in_category(Group) - groupinfo = [] - for group in groups: - contains_analog_blocks = False - block_list = [] - members = group.members() - for member in members: - if member.name().startswith("gr::analog"): - all_grouped_blocks.append(member) - if not contains_analog_blocks: - contains_analog_blocks = True - groupinfo.append((group.name(), group.title, block_list)) - block_list.append(member) - - for block in analog_blocks: - if block not in all_grouped_blocks: - print("Didn't find block {0}".format(block.name())) - - blockindex = ["""gnuradio.analog -=============== - -.. automodule:: gnuradio.analog"""] - for groupname, grouptitle, blocks in groupinfo: - blockindex.append("") - blockindex.append(grouptitle) - blockindex.append('-'*len(grouptitle)) - blockindex.append(""" -.. autosummary:: - :nosignatures: -""") - for block in blocks: - blockindex.append(" gnuradio.analog.{0}".format( - block.name()[len("gr::analog::"):])) - grouppage = [] - title = "gnuradio.analog: {0}".format(grouptitle) - grouppage.append(title) - grouppage.append('='*len(title)) - grouppage.append('') - for block in blocks: - shortname = block.name()[len("gr::analog::"):] - grouppage.append(".. autoblock:: gnuradio.analog.{0}".format(shortname)) - text = '\n'.join(grouppage) - f = open("{0}.rst".format(groupname), 'w') - f.write(text) - f.close() - text = "\n".join(blockindex) - f = open("index.rst", 'w') - f.write(text) - f.close() - -if __name__ == '__main__': - main() diff --git a/docs/sphinx/source/analog/index.rst b/docs/sphinx/source/analog/index.rst deleted file mode 100644 index 668247cab3..0000000000 --- a/docs/sphinx/source/analog/index.rst +++ /dev/null @@ -1,61 +0,0 @@ -gnuradio.analog -=============== - -.. automodule:: gnuradio.analog - -Level Controllers ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.analog.agc_cc - gnuradio.analog.agc2_cc - gnuradio.analog.agc2_ff - gnuradio.analog.agc_ff - gnuradio.analog.ctcss_squelch_ff - gnuradio.analog.feedforward_agc_cc - gnuradio.analog.pwr_squelch_cc - gnuradio.analog.pwr_squelch_ff - gnuradio.analog.rail_ff - gnuradio.analog.simple_squelch_cc - -Measurement Tools ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.analog.probe_avg_mag_sqrd_c - gnuradio.analog.probe_avg_mag_sqrd_cf - gnuradio.analog.probe_avg_mag_sqrd_f - -Modulators and Demodulators ---------------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.cpfsk_bc - gnuradio.analog.fmdet_cf - gnuradio.analog.frequency_modulator_fc - gnuradio.analog.phase_modulator_fc - gnuradio.analog.quadrature_demod_cf - -Peak Detectors --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.dpll_bb - -Synchronizers -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.pll_carriertracking_cc - gnuradio.analog.pll_freqdet_cf - gnuradio.analog.pll_refout_cc diff --git a/docs/sphinx/source/analog/level_controllers_blk.rst b/docs/sphinx/source/analog/level_controllers_blk.rst deleted file mode 100644 index 738535d207..0000000000 --- a/docs/sphinx/source/analog/level_controllers_blk.rst +++ /dev/null @@ -1,13 +0,0 @@ -gnuradio.analog: Level Controllers -================================== - -.. autoblock:: gnuradio.analog.agc_cc -.. autoblock:: gnuradio.analog.agc2_cc -.. autoblock:: gnuradio.analog.agc2_ff -.. autoblock:: gnuradio.analog.agc_ff -.. autoblock:: gnuradio.analog.ctcss_squelch_ff -.. autoblock:: gnuradio.analog.feedforward_agc_cc -.. autoblock:: gnuradio.analog.pwr_squelch_cc -.. autoblock:: gnuradio.analog.pwr_squelch_ff -.. autoblock:: gnuradio.analog.rail_ff -.. autoblock:: gnuradio.analog.simple_squelch_cc diff --git a/docs/sphinx/source/analog/measurement_tools_blk.rst b/docs/sphinx/source/analog/measurement_tools_blk.rst deleted file mode 100644 index be9accc7e5..0000000000 --- a/docs/sphinx/source/analog/measurement_tools_blk.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.analog: Measurement Tools -================================== - -.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_c -.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_cf -.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_f
\ No newline at end of file diff --git a/docs/sphinx/source/analog/modulators_blk.rst b/docs/sphinx/source/analog/modulators_blk.rst deleted file mode 100644 index 3e9f279271..0000000000 --- a/docs/sphinx/source/analog/modulators_blk.rst +++ /dev/null @@ -1,8 +0,0 @@ -gnuradio.analog: Modulators and Demodulators -============================================ - -.. autoblock:: gnuradio.analog.cpfsk_bc -.. autoblock:: gnuradio.analog.fmdet_cf -.. autoblock:: gnuradio.analog.frequency_modulator_fc -.. autoblock:: gnuradio.analog.phase_modulator_fc -.. autoblock:: gnuradio.analog.quadrature_demod_cf diff --git a/docs/sphinx/source/analog/peak_detectors_blk.rst b/docs/sphinx/source/analog/peak_detectors_blk.rst deleted file mode 100644 index 3105202c2a..0000000000 --- a/docs/sphinx/source/analog/peak_detectors_blk.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.analog: Peak Detectors -=============================== - -.. autoblock:: gnuradio.analog.dpll_bb
\ No newline at end of file diff --git a/docs/sphinx/source/analog/synchronizers_blk.rst b/docs/sphinx/source/analog/synchronizers_blk.rst deleted file mode 100644 index 938b24ad61..0000000000 --- a/docs/sphinx/source/analog/synchronizers_blk.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.analog: Synchronizers -============================== - -.. autoblock:: gnuradio.analog.pll_carriertracking_cc -.. autoblock:: gnuradio.analog.pll_freqdet_cf -.. autoblock:: gnuradio.analog.pll_refout_cc
\ No newline at end of file diff --git a/docs/sphinx/source/analog_blocks.rst b/docs/sphinx/source/analog_blocks.rst new file mode 100644 index 0000000000..bbf1a2275e --- /dev/null +++ b/docs/sphinx/source/analog_blocks.rst @@ -0,0 +1,40 @@ +gnuradio.analog +=============== + +.. automodule:: gnuradio.analog + +.. autoblock:: gnuradio.analog.agc2_cc +.. autoblock:: gnuradio.analog.agc2_ff +.. autoblock:: gnuradio.analog.agc3_cc +.. autoblock:: gnuradio.analog.agc_cc +.. autoblock:: gnuradio.analog.agc_ff +.. autoblock:: gnuradio.analog.cpfsk_bc +.. autoblock:: gnuradio.analog.ctcss_squelch_ff +.. autoblock:: gnuradio.analog.dpll_bb +.. autoblock:: gnuradio.analog.fastnoise_source_c +.. autoblock:: gnuradio.analog.fastnoise_source_f +.. autoblock:: gnuradio.analog.fastnoise_source_i +.. autoblock:: gnuradio.analog.fastnoise_source_s +.. autoblock:: gnuradio.analog.feedforward_agc_cc +.. autoblock:: gnuradio.analog.fmdet_cf +.. autoblock:: gnuradio.analog.frequency_modulator_fc +.. autoblock:: gnuradio.analog.noise_source_c +.. autoblock:: gnuradio.analog.noise_source_f +.. autoblock:: gnuradio.analog.noise_source_i +.. autoblock:: gnuradio.analog.noise_source_s +.. autoblock:: gnuradio.analog.phase_modulator_fc +.. autoblock:: gnuradio.analog.pll_carriertracking_cc +.. autoblock:: gnuradio.analog.pll_freqdet_cf +.. autoblock:: gnuradio.analog.pll_refout_cc +.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_c +.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_cf +.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_f +.. autoblock:: gnuradio.analog.pwr_squelch_cc +.. autoblock:: gnuradio.analog.pwr_squelch_ff +.. autoblock:: gnuradio.analog.quadrature_demod_cf +.. autoblock:: gnuradio.analog.rail_ff +.. autoblock:: gnuradio.analog.sig_source_c +.. autoblock:: gnuradio.analog.sig_source_f +.. autoblock:: gnuradio.analog.sig_source_i +.. autoblock:: gnuradio.analog.sig_source_s +.. autoblock:: gnuradio.analog.simple_squelch_cc 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 - diff --git a/docs/sphinx/source/audio/index.rst b/docs/sphinx/source/audio_blocks.rst index 31d53567b8..31d53567b8 100644 --- a/docs/sphinx/source/audio/index.rst +++ b/docs/sphinx/source/audio_blocks.rst diff --git a/docs/sphinx/source/blocks/audio_blk.rst b/docs/sphinx/source/blocks/audio_blk.rst deleted file mode 100644 index b73f9f3335..0000000000 --- a/docs/sphinx/source/blocks/audio_blk.rst +++ /dev/null @@ -1,5 +0,0 @@ -gnuradio.blocks: Audio Signals -============================== - -.. autoblock:: gnuradio.blocks.wavfile_sink -.. autoblock:: gnuradio.blocks.wavfile_source
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/boolean_operators_blk.rst b/docs/sphinx/source/blocks/boolean_operators_blk.rst deleted file mode 100644 index b6c2066d3e..0000000000 --- a/docs/sphinx/source/blocks/boolean_operators_blk.rst +++ /dev/null @@ -1,18 +0,0 @@ -gnuradio.blocks: Boolean Operators -================================== - -.. autoblock:: gnuradio.blocks.and_bb -.. autoblock:: gnuradio.blocks.and_const_bb -.. autoblock:: gnuradio.blocks.and_const_ii -.. autoblock:: gnuradio.blocks.and_const_ss -.. autoblock:: gnuradio.blocks.and_ii -.. autoblock:: gnuradio.blocks.and_ss -.. autoblock:: gnuradio.blocks.not_bb -.. autoblock:: gnuradio.blocks.not_ii -.. autoblock:: gnuradio.blocks.not_ss -.. autoblock:: gnuradio.blocks.or_bb -.. autoblock:: gnuradio.blocks.or_ii -.. autoblock:: gnuradio.blocks.or_ss -.. autoblock:: gnuradio.blocks.xor_bb -.. autoblock:: gnuradio.blocks.xor_ii -.. autoblock:: gnuradio.blocks.xor_ss
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/byte_operators_blk.rst b/docs/sphinx/source/blocks/byte_operators_blk.rst deleted file mode 100644 index 5ffc0e0ef7..0000000000 --- a/docs/sphinx/source/blocks/byte_operators_blk.rst +++ /dev/null @@ -1,12 +0,0 @@ -gnuradio.blocks: Byte Operators -=============================== - -.. autoblock:: gnuradio.blocks.packed_to_unpacked_bb -.. autoblock:: gnuradio.blocks.packed_to_unpacked_ii -.. autoblock:: gnuradio.blocks.packed_to_unpacked_ss -.. autoblock:: gnuradio.blocks.unpacked_to_packed_bb -.. autoblock:: gnuradio.blocks.unpacked_to_packed_ii -.. autoblock:: gnuradio.blocks.unpacked_to_packed_ss -.. autoblock:: gnuradio.blocks.pack_k_bits_bb -.. autoblock:: gnuradio.blocks.repack_bits_bb -.. autoblock:: gnuradio.blocks.unpack_k_bits_bb
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/controlport_blk.rst b/docs/sphinx/source/blocks/controlport_blk.rst deleted file mode 100644 index 0931c210de..0000000000 --- a/docs/sphinx/source/blocks/controlport_blk.rst +++ /dev/null @@ -1,5 +0,0 @@ -gnuradio.blocks: ControlPort -============================ - -.. autoblock:: gnuradio.blocks.ctrlport_probe2_c -.. autoblock:: gnuradio.blocks.ctrlport_probe_c
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/debug_tools_blk.rst b/docs/sphinx/source/blocks/debug_tools_blk.rst deleted file mode 100644 index f655023d32..0000000000 --- a/docs/sphinx/source/blocks/debug_tools_blk.rst +++ /dev/null @@ -1,14 +0,0 @@ -gnuradio.blocks: Debug Tools -============================ - -.. autoblock:: gnuradio.blocks.vector_sink_b -.. autoblock:: gnuradio.blocks.vector_sink_c -.. autoblock:: gnuradio.blocks.vector_sink_f -.. autoblock:: gnuradio.blocks.vector_sink_i -.. autoblock:: gnuradio.blocks.vector_sink_s -.. autoblock:: gnuradio.blocks.annotator_1to1 -.. autoblock:: gnuradio.blocks.annotator_alltoall -.. autoblock:: gnuradio.blocks.annotator_raw -.. autoblock:: gnuradio.blocks.message_debug -.. autoblock:: gnuradio.blocks.random_pdu -.. autoblock:: gnuradio.blocks.tag_debug
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/file_operators_blk.rst b/docs/sphinx/source/blocks/file_operators_blk.rst deleted file mode 100644 index a01d3a08c6..0000000000 --- a/docs/sphinx/source/blocks/file_operators_blk.rst +++ /dev/null @@ -1,10 +0,0 @@ -gnuradio.blocks: File Operators -=============================== - -.. autoblock:: gnuradio.blocks.file_descriptor_sink -.. autoblock:: gnuradio.blocks.file_descriptor_source -.. autoblock:: gnuradio.blocks.file_meta_sink -.. autoblock:: gnuradio.blocks.file_meta_source -.. autoblock:: gnuradio.blocks.file_sink -.. autoblock:: gnuradio.blocks.file_source -.. autoblock:: gnuradio.blocks.tagged_file_sink
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/get_blocks.py b/docs/sphinx/source/blocks/get_blocks.py deleted file mode 100644 index 18c334c8c6..0000000000 --- a/docs/sphinx/source/blocks/get_blocks.py +++ /dev/null @@ -1,106 +0,0 @@ -""" -This script regenerates the gnuradio.blocks sphinx source code. -""" - -from gnuradio import blocks -import sys -import os - -doxyxml_location = os.path.abspath("../../../doxygen") -xml_location = os.path.abspath("../../../../build/docs/doxygen/xml/") -sys.path.append(doxyxml_location) - -from doxyxml import DoxyIndex, DoxyClass, DoxyFriend, DoxyFunction, DoxyFile, DoxyGroup -from doxyxml import DoxyOther, base - -class Block(object): - """ - Checks if doxyxml produced objects correspond to a new style - gnuradio block. - """ - - @classmethod - def includes(cls, item): - if not isinstance(item, DoxyClass): - return False - # Check for a parsing error. - if item.error(): - return False - is_a_block = item.has_member('make', DoxyFunction) and item.has_member('sptr', DoxyOther) - return is_a_block - -class Group(object): - """ - Checks if doxyxml produced objects correspond to a group. - """ - - @classmethod - def includes(cls, item): - if not isinstance(item, DoxyGroup): - return False - # Check for a parsing error. - if item.error(): - return False - return True - -def main(): - di = DoxyIndex(xml_location) - blocks = di.in_category(Block) - block_blocks = [] - for block in blocks: - if block.name().startswith("gr::blocks::"): - block_blocks.append(block) - - all_grouped_blocks = [] - groups = di.in_category(Group) - groupinfo = [] - for group in groups: - contains_block_blocks = False - block_list = [] - members = group.members() - for member in members: - if member.name().startswith("gr::blocks"): - all_grouped_blocks.append(member) - if not contains_block_blocks: - contains_block_blocks = True - groupinfo.append((group.name(), group.title, block_list)) - block_list.append(member) - - for block in block_blocks: - if block not in all_grouped_blocks: - print("Didn't find block {0}".format(block.name())) - - blockindex = ["""gnuradio.blocks -=============== - -.. automodule:: gnuradio.blocks"""] - for groupname, grouptitle, blocks in groupinfo: - blockindex.append("") - blockindex.append(grouptitle) - blockindex.append('-'*len(grouptitle)) - blockindex.append(""" -.. autosummary:: - :nosignatures: -""") - for block in blocks: - blockindex.append(" gnuradio.blocks.{0}".format( - block.name()[len("gr::blocks::"):])) - grouppage = [] - title = "gnuradio.blocks: {0}".format(grouptitle) - grouppage.append(title) - grouppage.append('='*len(title)) - grouppage.append('') - for block in blocks: - shortname = block.name()[len("gr::blocks::"):] - grouppage.append(".. autoblock:: gnuradio.blocks.{0}".format(shortname)) - text = '\n'.join(grouppage) - f = open("{0}.rst".format(groupname), 'w') - f.write(text) - f.close() - text = "\n".join(blockindex) - f = open("index.rst", 'w') - f.write(text) - f.close() - -if __name__ == '__main__': - main() diff --git a/docs/sphinx/source/blocks/index.rst b/docs/sphinx/source/blocks/index.rst deleted file mode 100644 index f89c9c5df5..0000000000 --- a/docs/sphinx/source/blocks/index.rst +++ /dev/null @@ -1,337 +0,0 @@ -gnuradio.blocks -=============== - -.. automodule:: gnuradio.blocks - -Audio Signals -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.wavfile_sink - gnuradio.blocks.wavfile_source - -Boolean Operators ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.and_bb - gnuradio.blocks.and_const_bb - gnuradio.blocks.and_const_ii - gnuradio.blocks.and_const_ss - gnuradio.blocks.and_ii - gnuradio.blocks.and_ss - gnuradio.blocks.not_bb - gnuradio.blocks.not_ii - gnuradio.blocks.not_ss - gnuradio.blocks.or_bb - gnuradio.blocks.or_ii - gnuradio.blocks.or_ss - gnuradio.blocks.xor_bb - gnuradio.blocks.xor_ii - gnuradio.blocks.xor_ss - -Byte Operators --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.packed_to_unpacked_bb - gnuradio.blocks.packed_to_unpacked_ii - gnuradio.blocks.packed_to_unpacked_ss - gnuradio.blocks.unpacked_to_packed_bb - gnuradio.blocks.unpacked_to_packed_ii - gnuradio.blocks.unpacked_to_packed_ss - gnuradio.blocks.pack_k_bits_bb - gnuradio.blocks.repack_bits_bb - gnuradio.blocks.unpack_k_bits_bb - -ControlPort ------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.ctrlport_probe2_c - gnuradio.blocks.ctrlport_probe_c - -Debug Tools ------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.vector_sink_b - gnuradio.blocks.vector_sink_c - gnuradio.blocks.vector_sink_f - gnuradio.blocks.vector_sink_i - gnuradio.blocks.vector_sink_s - gnuradio.blocks.annotator_1to1 - gnuradio.blocks.annotator_alltoall - gnuradio.blocks.annotator_raw - gnuradio.blocks.message_debug - gnuradio.blocks.random_pdu - gnuradio.blocks.tag_debug - -File Operators --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.file_descriptor_sink - gnuradio.blocks.file_descriptor_source - gnuradio.blocks.file_meta_sink - gnuradio.blocks.file_meta_source - gnuradio.blocks.file_sink - gnuradio.blocks.file_source - gnuradio.blocks.tagged_file_sink - -Level Controllers ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.moving_average_cc - gnuradio.blocks.moving_average_ff - gnuradio.blocks.moving_average_ii - gnuradio.blocks.moving_average_ss - gnuradio.blocks.mute_cc - gnuradio.blocks.mute_ff - gnuradio.blocks.mute_ii - gnuradio.blocks.mute_ss - gnuradio.blocks.sample_and_hold_bb - gnuradio.blocks.sample_and_hold_ff - gnuradio.blocks.sample_and_hold_ii - gnuradio.blocks.sample_and_hold_ss - gnuradio.blocks.threshold_ff - -Math Operators --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.add_cc - gnuradio.blocks.add_const_bb - gnuradio.blocks.add_const_cc - gnuradio.blocks.add_const_ff - gnuradio.blocks.add_const_ii - gnuradio.blocks.add_const_ss - gnuradio.blocks.add_const_vbb - gnuradio.blocks.add_const_vcc - gnuradio.blocks.add_const_vff - gnuradio.blocks.add_const_vii - gnuradio.blocks.add_const_vss - gnuradio.blocks.add_ii - gnuradio.blocks.add_ss - gnuradio.blocks.argmax_fs - gnuradio.blocks.argmax_is - gnuradio.blocks.argmax_ss - gnuradio.blocks.divide_cc - gnuradio.blocks.divide_ff - gnuradio.blocks.divide_ii - gnuradio.blocks.divide_ss - gnuradio.blocks.integrate_cc - gnuradio.blocks.integrate_ff - gnuradio.blocks.integrate_ii - gnuradio.blocks.integrate_ss - gnuradio.blocks.max_ff - gnuradio.blocks.max_ii - gnuradio.blocks.max_ss - gnuradio.blocks.multiply_const_ii - gnuradio.blocks.multiply_const_ss - gnuradio.blocks.multiply_const_vcc - gnuradio.blocks.multiply_const_vff - gnuradio.blocks.multiply_const_vii - gnuradio.blocks.multiply_const_vss - gnuradio.blocks.multiply_ii - gnuradio.blocks.multiply_ss - gnuradio.blocks.sub_cc - gnuradio.blocks.sub_ff - gnuradio.blocks.sub_ii - gnuradio.blocks.sub_ss - gnuradio.blocks.add_ff - gnuradio.blocks.conjugate_cc - gnuradio.blocks.multiply_cc - gnuradio.blocks.multiply_conjugate_cc - gnuradio.blocks.multiply_const_cc - gnuradio.blocks.multiply_const_ff - gnuradio.blocks.multiply_ff - gnuradio.blocks.nlog10_ff - gnuradio.blocks.rms_cf - gnuradio.blocks.rms_ff - gnuradio.blocks.transcendental - -Measurement Tools ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.probe_signal_b - gnuradio.blocks.probe_signal_c - gnuradio.blocks.probe_signal_f - gnuradio.blocks.probe_signal_i - gnuradio.blocks.probe_signal_s - gnuradio.blocks.probe_signal_vb - gnuradio.blocks.probe_signal_vc - gnuradio.blocks.probe_signal_vf - gnuradio.blocks.probe_signal_vi - gnuradio.blocks.probe_signal_vs - gnuradio.blocks.ctrlport_probe2_c - :noindex: - gnuradio.blocks.ctrlport_probe_c - :noindex: - gnuradio.blocks.message_debug - :noindex: - gnuradio.blocks.probe_rate - gnuradio.blocks.tag_debug - :noindex: - -Message Tools -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.message_burst_source - gnuradio.blocks.message_debug - :noindex: - gnuradio.blocks.message_sink - gnuradio.blocks.message_source - gnuradio.blocks.message_strobe - gnuradio.blocks.pdu_to_tagged_stream - gnuradio.blocks.random_pdu - :noindex: - gnuradio.blocks.tagged_stream_to_pdu - -Miscellaneous -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.vector_source_b - gnuradio.blocks.vector_source_c - gnuradio.blocks.vector_source_f - gnuradio.blocks.vector_source_i - gnuradio.blocks.vector_source_s - gnuradio.blocks.bin_statistics_f - gnuradio.blocks.check_lfsr_32k_s - gnuradio.blocks.copy - gnuradio.blocks.delay - gnuradio.blocks.head - gnuradio.blocks.lfsr_32k_source_s - gnuradio.blocks.nop - gnuradio.blocks.null_sink - gnuradio.blocks.null_source - gnuradio.blocks.skiphead - gnuradio.blocks.throttle - -Modulators and Demodulators ---------------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.vco_f - -Networking Tools ----------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.socket_pdu - gnuradio.blocks.tuntap_pdu - gnuradio.blocks.udp_sink - gnuradio.blocks.udp_source - -Peak Detectors --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.peak_detector_fb - gnuradio.blocks.peak_detector_ib - gnuradio.blocks.peak_detector_sb - gnuradio.blocks.burst_tagger - gnuradio.blocks.peak_detector2_fb - gnuradio.blocks.plateau_detector_fb - -Stream Operators ----------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.vector_insert_b - gnuradio.blocks.vector_insert_c - gnuradio.blocks.vector_insert_f - gnuradio.blocks.vector_insert_i - gnuradio.blocks.vector_insert_s - gnuradio.blocks.deinterleave - gnuradio.blocks.endian_swap - gnuradio.blocks.interleave - gnuradio.blocks.keep_m_in_n - gnuradio.blocks.keep_one_in_n - gnuradio.blocks.patterned_interleaver - gnuradio.blocks.regenerate_bb - gnuradio.blocks.repeat - gnuradio.blocks.stream_mux - gnuradio.blocks.stream_to_streams - gnuradio.blocks.stream_to_vector - gnuradio.blocks.streams_to_stream - gnuradio.blocks.streams_to_vector - gnuradio.blocks.stretch_ff - gnuradio.blocks.tagged_stream_mux - gnuradio.blocks.vector_map - gnuradio.blocks.vector_to_stream - gnuradio.blocks.vector_to_streams - -Stream Tag Tools ----------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.burst_tagger - :noindex: - gnuradio.blocks.tag_debug - :noindex: - gnuradio.blocks.tagged_file_sink - :noindex: - -Data Type Converters --------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.char_to_float - gnuradio.blocks.char_to_short - gnuradio.blocks.complex_to_arg - gnuradio.blocks.complex_to_float - gnuradio.blocks.complex_to_imag - gnuradio.blocks.complex_to_interleaved_short - gnuradio.blocks.complex_to_mag - gnuradio.blocks.complex_to_mag_squared - gnuradio.blocks.complex_to_real - gnuradio.blocks.float_to_char - gnuradio.blocks.float_to_complex - gnuradio.blocks.float_to_int - gnuradio.blocks.float_to_short - gnuradio.blocks.float_to_uchar - gnuradio.blocks.int_to_float - gnuradio.blocks.interleaved_short_to_complex - gnuradio.blocks.short_to_char - gnuradio.blocks.short_to_float - gnuradio.blocks.uchar_to_float - diff --git a/docs/sphinx/source/blocks/level_controllers_blk.rst b/docs/sphinx/source/blocks/level_controllers_blk.rst deleted file mode 100644 index 4e0b209479..0000000000 --- a/docs/sphinx/source/blocks/level_controllers_blk.rst +++ /dev/null @@ -1,16 +0,0 @@ -gnuradio.blocks: Level Controllers -================================== - -.. autoblock:: gnuradio.blocks.moving_average_cc -.. autoblock:: gnuradio.blocks.moving_average_ff -.. autoblock:: gnuradio.blocks.moving_average_ii -.. autoblock:: gnuradio.blocks.moving_average_ss -.. autoblock:: gnuradio.blocks.mute_cc -.. autoblock:: gnuradio.blocks.mute_ff -.. autoblock:: gnuradio.blocks.mute_ii -.. autoblock:: gnuradio.blocks.mute_ss -.. autoblock:: gnuradio.blocks.sample_and_hold_bb -.. autoblock:: gnuradio.blocks.sample_and_hold_ff -.. autoblock:: gnuradio.blocks.sample_and_hold_ii -.. autoblock:: gnuradio.blocks.sample_and_hold_ss -.. autoblock:: gnuradio.blocks.threshold_ff
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/math_operators_blk.rst b/docs/sphinx/source/blocks/math_operators_blk.rst deleted file mode 100644 index 59f868a187..0000000000 --- a/docs/sphinx/source/blocks/math_operators_blk.rst +++ /dev/null @@ -1,53 +0,0 @@ -gnuradio.blocks: Math Operators -=============================== - -.. autoblock:: gnuradio.blocks.add_cc -.. autoblock:: gnuradio.blocks.add_const_bb -.. autoblock:: gnuradio.blocks.add_const_cc -.. autoblock:: gnuradio.blocks.add_const_ff -.. autoblock:: gnuradio.blocks.add_const_ii -.. autoblock:: gnuradio.blocks.add_const_ss -.. autoblock:: gnuradio.blocks.add_const_vbb -.. autoblock:: gnuradio.blocks.add_const_vcc -.. autoblock:: gnuradio.blocks.add_const_vff -.. autoblock:: gnuradio.blocks.add_const_vii -.. autoblock:: gnuradio.blocks.add_const_vss -.. autoblock:: gnuradio.blocks.add_ii -.. autoblock:: gnuradio.blocks.add_ss -.. autoblock:: gnuradio.blocks.argmax_fs -.. autoblock:: gnuradio.blocks.argmax_is -.. autoblock:: gnuradio.blocks.argmax_ss -.. autoblock:: gnuradio.blocks.divide_cc -.. autoblock:: gnuradio.blocks.divide_ff -.. autoblock:: gnuradio.blocks.divide_ii -.. autoblock:: gnuradio.blocks.divide_ss -.. autoblock:: gnuradio.blocks.integrate_cc -.. autoblock:: gnuradio.blocks.integrate_ff -.. autoblock:: gnuradio.blocks.integrate_ii -.. autoblock:: gnuradio.blocks.integrate_ss -.. autoblock:: gnuradio.blocks.max_ff -.. autoblock:: gnuradio.blocks.max_ii -.. autoblock:: gnuradio.blocks.max_ss -.. autoblock:: gnuradio.blocks.multiply_const_ii -.. autoblock:: gnuradio.blocks.multiply_const_ss -.. autoblock:: gnuradio.blocks.multiply_const_vcc -.. autoblock:: gnuradio.blocks.multiply_const_vff -.. autoblock:: gnuradio.blocks.multiply_const_vii -.. autoblock:: gnuradio.blocks.multiply_const_vss -.. autoblock:: gnuradio.blocks.multiply_ii -.. autoblock:: gnuradio.blocks.multiply_ss -.. autoblock:: gnuradio.blocks.sub_cc -.. autoblock:: gnuradio.blocks.sub_ff -.. autoblock:: gnuradio.blocks.sub_ii -.. autoblock:: gnuradio.blocks.sub_ss -.. autoblock:: gnuradio.blocks.add_ff -.. autoblock:: gnuradio.blocks.conjugate_cc -.. autoblock:: gnuradio.blocks.multiply_cc -.. autoblock:: gnuradio.blocks.multiply_conjugate_cc -.. autoblock:: gnuradio.blocks.multiply_const_cc -.. autoblock:: gnuradio.blocks.multiply_const_ff -.. autoblock:: gnuradio.blocks.multiply_ff -.. autoblock:: gnuradio.blocks.nlog10_ff -.. autoblock:: gnuradio.blocks.rms_cf -.. autoblock:: gnuradio.blocks.rms_ff -.. autoblock:: gnuradio.blocks.transcendental
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/measurement_tools_blk.rst b/docs/sphinx/source/blocks/measurement_tools_blk.rst deleted file mode 100644 index 0669042594..0000000000 --- a/docs/sphinx/source/blocks/measurement_tools_blk.rst +++ /dev/null @@ -1,18 +0,0 @@ -gnuradio.blocks: Measurement Tools -================================== - -.. autoblock:: gnuradio.blocks.probe_signal_b -.. autoblock:: gnuradio.blocks.probe_signal_c -.. autoblock:: gnuradio.blocks.probe_signal_f -.. autoblock:: gnuradio.blocks.probe_signal_i -.. autoblock:: gnuradio.blocks.probe_signal_s -.. autoblock:: gnuradio.blocks.probe_signal_vb -.. autoblock:: gnuradio.blocks.probe_signal_vc -.. autoblock:: gnuradio.blocks.probe_signal_vf -.. autoblock:: gnuradio.blocks.probe_signal_vi -.. autoblock:: gnuradio.blocks.probe_signal_vs -.. autoblock:: gnuradio.blocks.ctrlport_probe2_c -.. autoblock:: gnuradio.blocks.ctrlport_probe_c -.. autoblock:: gnuradio.blocks.message_debug -.. autoblock:: gnuradio.blocks.probe_rate -.. autoblock:: gnuradio.blocks.tag_debug
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/message_tools_blk.rst b/docs/sphinx/source/blocks/message_tools_blk.rst deleted file mode 100644 index 37b63ab444..0000000000 --- a/docs/sphinx/source/blocks/message_tools_blk.rst +++ /dev/null @@ -1,11 +0,0 @@ -gnuradio.blocks: Message Tools -============================== - -.. autoblock:: gnuradio.blocks.message_burst_source -.. autoblock:: gnuradio.blocks.message_debug -.. autoblock:: gnuradio.blocks.message_sink -.. autoblock:: gnuradio.blocks.message_source -.. autoblock:: gnuradio.blocks.message_strobe -.. autoblock:: gnuradio.blocks.pdu_to_tagged_stream -.. autoblock:: gnuradio.blocks.random_pdu -.. autoblock:: gnuradio.blocks.tagged_stream_to_pdu
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/misc_blk.rst b/docs/sphinx/source/blocks/misc_blk.rst deleted file mode 100644 index 7a39845556..0000000000 --- a/docs/sphinx/source/blocks/misc_blk.rst +++ /dev/null @@ -1,19 +0,0 @@ -gnuradio.blocks: Miscellaneous -============================== - -.. autoblock:: gnuradio.blocks.vector_source_b -.. autoblock:: gnuradio.blocks.vector_source_c -.. autoblock:: gnuradio.blocks.vector_source_f -.. autoblock:: gnuradio.blocks.vector_source_i -.. autoblock:: gnuradio.blocks.vector_source_s -.. autoblock:: gnuradio.blocks.bin_statistics_f -.. autoblock:: gnuradio.blocks.check_lfsr_32k_s -.. autoblock:: gnuradio.blocks.copy -.. autoblock:: gnuradio.blocks.delay -.. autoblock:: gnuradio.blocks.head -.. autoblock:: gnuradio.blocks.lfsr_32k_source_s -.. autoblock:: gnuradio.blocks.nop -.. autoblock:: gnuradio.blocks.null_sink -.. autoblock:: gnuradio.blocks.null_source -.. autoblock:: gnuradio.blocks.skiphead -.. autoblock:: gnuradio.blocks.throttle
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/modulators_blk.rst b/docs/sphinx/source/blocks/modulators_blk.rst deleted file mode 100644 index ad35ed8c7a..0000000000 --- a/docs/sphinx/source/blocks/modulators_blk.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.blocks: Modulators and Demodulators -============================================ - -.. autoblock:: gnuradio.blocks.vco_f
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/networking_tools_blk.rst b/docs/sphinx/source/blocks/networking_tools_blk.rst deleted file mode 100644 index e3e2450e2c..0000000000 --- a/docs/sphinx/source/blocks/networking_tools_blk.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.blocks: Networking Tools -================================= - -.. autoblock:: gnuradio.blocks.socket_pdu -.. autoblock:: gnuradio.blocks.tuntap_pdu -.. autoblock:: gnuradio.blocks.udp_sink -.. autoblock:: gnuradio.blocks.udp_source diff --git a/docs/sphinx/source/blocks/peak_detectors_blk.rst b/docs/sphinx/source/blocks/peak_detectors_blk.rst deleted file mode 100644 index 1dee645d0a..0000000000 --- a/docs/sphinx/source/blocks/peak_detectors_blk.rst +++ /dev/null @@ -1,9 +0,0 @@ -gnuradio.blocks: Peak Detectors -=============================== - -.. autoblock:: gnuradio.blocks.peak_detector_fb -.. autoblock:: gnuradio.blocks.peak_detector_ib -.. autoblock:: gnuradio.blocks.peak_detector_sb -.. autoblock:: gnuradio.blocks.burst_tagger -.. autoblock:: gnuradio.blocks.peak_detector2_fb -.. autoblock:: gnuradio.blocks.plateau_detector_fb
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/stream_operators_blk.rst b/docs/sphinx/source/blocks/stream_operators_blk.rst deleted file mode 100644 index 9c470f3806..0000000000 --- a/docs/sphinx/source/blocks/stream_operators_blk.rst +++ /dev/null @@ -1,26 +0,0 @@ -gnuradio.blocks: Streams Operators -================================== - -.. autoblock:: gnuradio.blocks.vector_insert_b -.. autoblock:: gnuradio.blocks.vector_insert_c -.. autoblock:: gnuradio.blocks.vector_insert_f -.. autoblock:: gnuradio.blocks.vector_insert_i -.. autoblock:: gnuradio.blocks.vector_insert_s -.. autoblock:: gnuradio.blocks.deinterleave -.. autoblock:: gnuradio.blocks.endian_swap -.. autoblock:: gnuradio.blocks.interleave -.. autoblock:: gnuradio.blocks.keep_m_in_n -.. autoblock:: gnuradio.blocks.keep_one_in_n -.. autoblock:: gnuradio.blocks.patterned_interleaver -.. autoblock:: gnuradio.blocks.regenerate_bb -.. autoblock:: gnuradio.blocks.repeat -.. autoblock:: gnuradio.blocks.stream_mux -.. autoblock:: gnuradio.blocks.stream_to_streams -.. autoblock:: gnuradio.blocks.stream_to_vector -.. autoblock:: gnuradio.blocks.streams_to_stream -.. autoblock:: gnuradio.blocks.streams_to_vector -.. autoblock:: gnuradio.blocks.stretch_ff -.. autoblock:: gnuradio.blocks.tagged_stream_mux -.. autoblock:: gnuradio.blocks.vector_map -.. autoblock:: gnuradio.blocks.vector_to_stream -.. autoblock:: gnuradio.blocks.vector_to_streams
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/stream_tag_tools_blk.rst b/docs/sphinx/source/blocks/stream_tag_tools_blk.rst deleted file mode 100644 index 1eab0eae2f..0000000000 --- a/docs/sphinx/source/blocks/stream_tag_tools_blk.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.blocks: Stream Tag Tools -================================= - -.. autoblock:: gnuradio.blocks.burst_tagger -.. autoblock:: gnuradio.blocks.tag_debug -.. autoblock:: gnuradio.blocks.tagged_file_sink
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/type_converters_blk.rst b/docs/sphinx/source/blocks/type_converters_blk.rst deleted file mode 100644 index 56567c89e9..0000000000 --- a/docs/sphinx/source/blocks/type_converters_blk.rst +++ /dev/null @@ -1,22 +0,0 @@ -gnuradio.blocks: Data Type Converters -===================================== - -.. autoblock:: gnuradio.blocks.char_to_float -.. autoblock:: gnuradio.blocks.char_to_short -.. autoblock:: gnuradio.blocks.complex_to_arg -.. autoblock:: gnuradio.blocks.complex_to_float -.. autoblock:: gnuradio.blocks.complex_to_imag -.. autoblock:: gnuradio.blocks.complex_to_interleaved_short -.. autoblock:: gnuradio.blocks.complex_to_mag -.. autoblock:: gnuradio.blocks.complex_to_mag_squared -.. autoblock:: gnuradio.blocks.complex_to_real -.. autoblock:: gnuradio.blocks.float_to_char -.. autoblock:: gnuradio.blocks.float_to_complex -.. autoblock:: gnuradio.blocks.float_to_int -.. autoblock:: gnuradio.blocks.float_to_short -.. autoblock:: gnuradio.blocks.float_to_uchar -.. autoblock:: gnuradio.blocks.int_to_float -.. autoblock:: gnuradio.blocks.interleaved_short_to_complex -.. autoblock:: gnuradio.blocks.short_to_char -.. autoblock:: gnuradio.blocks.short_to_float -.. autoblock:: gnuradio.blocks.uchar_to_float
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/waveform_generators_blk.rst b/docs/sphinx/source/blocks/waveform_generators_blk.rst deleted file mode 100644 index b3edeeb936..0000000000 --- a/docs/sphinx/source/blocks/waveform_generators_blk.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.blocks: Waveform Generators -==================================== - -.. autoblock:: gnuradio.blocks.vco_f
\ No newline at end of file diff --git a/docs/sphinx/source/blocks_blocks.rst b/docs/sphinx/source/blocks_blocks.rst new file mode 100644 index 0000000000..056e9efe9a --- /dev/null +++ b/docs/sphinx/source/blocks_blocks.rst @@ -0,0 +1,228 @@ +gnuradio.blocks +=============== + +.. automodule:: gnuradio.blocks + +.. autoblock:: gnuradio.blocks.abs_ff +.. autoblock:: gnuradio.blocks.abs_ii +.. autoblock:: gnuradio.blocks.abs_ss +.. autoblock:: gnuradio.blocks.add_cc +.. autoblock:: gnuradio.blocks.add_const_bb +.. autoblock:: gnuradio.blocks.add_const_cc +.. autoblock:: gnuradio.blocks.add_const_ff +.. autoblock:: gnuradio.blocks.add_const_ii +.. autoblock:: gnuradio.blocks.add_const_ss +.. autoblock:: gnuradio.blocks.add_const_vbb +.. autoblock:: gnuradio.blocks.add_const_vcc +.. autoblock:: gnuradio.blocks.add_const_vff +.. autoblock:: gnuradio.blocks.add_const_vii +.. autoblock:: gnuradio.blocks.add_const_vss +.. autoblock:: gnuradio.blocks.add_ff +.. autoblock:: gnuradio.blocks.add_ii +.. autoblock:: gnuradio.blocks.add_ss +.. autoblock:: gnuradio.blocks.and_bb +.. autoblock:: gnuradio.blocks.and_const_bb +.. autoblock:: gnuradio.blocks.and_const_ii +.. autoblock:: gnuradio.blocks.and_const_ss +.. autoblock:: gnuradio.blocks.and_ii +.. autoblock:: gnuradio.blocks.and_ss +.. autoblock:: gnuradio.blocks.annotator_1to1 +.. autoblock:: gnuradio.blocks.annotator_alltoall +.. autoblock:: gnuradio.blocks.annotator_raw +.. autoblock:: gnuradio.blocks.argmax_fs +.. autoblock:: gnuradio.blocks.argmax_is +.. autoblock:: gnuradio.blocks.argmax_ss +.. autoblock:: gnuradio.blocks.bin_statistics_f +.. autoblock:: gnuradio.blocks.burst_tagger +.. autoblock:: gnuradio.blocks.char_to_float +.. autoblock:: gnuradio.blocks.char_to_short +.. autoblock:: gnuradio.blocks.check_lfsr_32k_s +.. autoblock:: gnuradio.blocks.complex_to_arg +.. autoblock:: gnuradio.blocks.complex_to_float +.. autoblock:: gnuradio.blocks.complex_to_imag +.. autoblock:: gnuradio.blocks.complex_to_interleaved_short +.. autoblock:: gnuradio.blocks.complex_to_mag +.. autoblock:: gnuradio.blocks.complex_to_mag_squared +.. autoblock:: gnuradio.blocks.complex_to_real +.. autoblock:: gnuradio.blocks.conjugate_cc +.. autoblock:: gnuradio.blocks.copy +.. autoblock:: gnuradio.blocks.ctrlport_probe2_b +.. autoblock:: gnuradio.blocks.ctrlport_probe2_c +.. autoblock:: gnuradio.blocks.ctrlport_probe2_f +.. autoblock:: gnuradio.blocks.ctrlport_probe2_i +.. autoblock:: gnuradio.blocks.ctrlport_probe2_s +.. autoblock:: gnuradio.blocks.ctrlport_probe_c +.. autoblock:: gnuradio.blocks.deinterleave +.. autoblock:: gnuradio.blocks.delay +.. autoblock:: gnuradio.blocks.divide_cc +.. autoblock:: gnuradio.blocks.divide_ff +.. autoblock:: gnuradio.blocks.divide_ii +.. autoblock:: gnuradio.blocks.divide_ss +.. autoblock:: gnuradio.blocks.endian_swap +.. autoblock:: gnuradio.blocks.file_descriptor_sink +.. autoblock:: gnuradio.blocks.file_descriptor_source +.. autoblock:: gnuradio.blocks.file_meta_sink +.. autoblock:: gnuradio.blocks.file_meta_source +.. autoblock:: gnuradio.blocks.file_sink +.. autoblock:: gnuradio.blocks.file_source +.. autoblock:: gnuradio.blocks.float_to_char +.. autoblock:: gnuradio.blocks.float_to_complex +.. autoblock:: gnuradio.blocks.float_to_int +.. autoblock:: gnuradio.blocks.float_to_short +.. autoblock:: gnuradio.blocks.float_to_uchar +.. autoblock:: gnuradio.blocks.head +.. autoblock:: gnuradio.blocks.int_to_float +.. autoblock:: gnuradio.blocks.integrate_cc +.. autoblock:: gnuradio.blocks.integrate_ff +.. autoblock:: gnuradio.blocks.integrate_ii +.. autoblock:: gnuradio.blocks.integrate_ss +.. autoblock:: gnuradio.blocks.interleave +.. autoblock:: gnuradio.blocks.interleaved_char_to_complex +.. autoblock:: gnuradio.blocks.interleaved_short_to_complex +.. autoblock:: gnuradio.blocks.keep_m_in_n +.. autoblock:: gnuradio.blocks.keep_one_in_n +.. autoblock:: gnuradio.blocks.lfsr_32k_source_s +.. autoblock:: gnuradio.blocks.max_ff +.. autoblock:: gnuradio.blocks.max_ii +.. autoblock:: gnuradio.blocks.max_ss +.. autoblock:: gnuradio.blocks.message_burst_source +.. autoblock:: gnuradio.blocks.message_debug +.. autoblock:: gnuradio.blocks.message_sink +.. autoblock:: gnuradio.blocks.message_source +.. autoblock:: gnuradio.blocks.message_strobe +.. autoblock:: gnuradio.blocks.message_strobe_random +.. autoblock:: gnuradio.blocks.min_ff +.. autoblock:: gnuradio.blocks.min_ii +.. autoblock:: gnuradio.blocks.min_ss +.. autoblock:: gnuradio.blocks.moving_average_cc +.. autoblock:: gnuradio.blocks.moving_average_ff +.. autoblock:: gnuradio.blocks.moving_average_ii +.. autoblock:: gnuradio.blocks.moving_average_ss +.. autoblock:: gnuradio.blocks.multiply_cc +.. autoblock:: gnuradio.blocks.multiply_conjugate_cc +.. autoblock:: gnuradio.blocks.multiply_const_cc +.. autoblock:: gnuradio.blocks.multiply_const_ff +.. autoblock:: gnuradio.blocks.multiply_const_ii +.. autoblock:: gnuradio.blocks.multiply_const_ss +.. autoblock:: gnuradio.blocks.multiply_const_vcc +.. autoblock:: gnuradio.blocks.multiply_const_vff +.. autoblock:: gnuradio.blocks.multiply_const_vii +.. autoblock:: gnuradio.blocks.multiply_const_vss +.. autoblock:: gnuradio.blocks.multiply_ff +.. autoblock:: gnuradio.blocks.multiply_ii +.. autoblock:: gnuradio.blocks.multiply_matrix_ff +.. autoblock:: gnuradio.blocks.multiply_ss +.. autoblock:: gnuradio.blocks.mute_cc +.. autoblock:: gnuradio.blocks.mute_ff +.. autoblock:: gnuradio.blocks.mute_ii +.. autoblock:: gnuradio.blocks.mute_ss +.. autoblock:: gnuradio.blocks.nlog10_ff +.. autoblock:: gnuradio.blocks.nop +.. autoblock:: gnuradio.blocks.not_bb +.. autoblock:: gnuradio.blocks.not_ii +.. autoblock:: gnuradio.blocks.not_ss +.. autoblock:: gnuradio.blocks.null_sink +.. autoblock:: gnuradio.blocks.null_source +.. autoblock:: gnuradio.blocks.or_bb +.. autoblock:: gnuradio.blocks.or_ii +.. autoblock:: gnuradio.blocks.or_ss +.. autoblock:: gnuradio.blocks.pack_k_bits_bb +.. autoblock:: gnuradio.blocks.packed_to_unpacked_bb +.. autoblock:: gnuradio.blocks.packed_to_unpacked_ii +.. autoblock:: gnuradio.blocks.packed_to_unpacked_ss +.. autoblock:: gnuradio.blocks.patterned_interleaver +.. autoblock:: gnuradio.blocks.pdu_filter +.. autoblock:: gnuradio.blocks.pdu_remove +.. autoblock:: gnuradio.blocks.pdu_set +.. autoblock:: gnuradio.blocks.pdu_to_tagged_stream +.. autoblock:: gnuradio.blocks.peak_detector2_fb +.. autoblock:: gnuradio.blocks.peak_detector_fb +.. autoblock:: gnuradio.blocks.peak_detector_ib +.. autoblock:: gnuradio.blocks.peak_detector_sb +.. autoblock:: gnuradio.blocks.plateau_detector_fb +.. autoblock:: gnuradio.blocks.probe_rate +.. autoblock:: gnuradio.blocks.probe_signal_b +.. autoblock:: gnuradio.blocks.probe_signal_c +.. autoblock:: gnuradio.blocks.probe_signal_f +.. autoblock:: gnuradio.blocks.probe_signal_i +.. autoblock:: gnuradio.blocks.probe_signal_s +.. autoblock:: gnuradio.blocks.probe_signal_vb +.. autoblock:: gnuradio.blocks.probe_signal_vc +.. autoblock:: gnuradio.blocks.probe_signal_vf +.. autoblock:: gnuradio.blocks.probe_signal_vi +.. autoblock:: gnuradio.blocks.probe_signal_vs +.. autoblock:: gnuradio.blocks.random_pdu +.. autoblock:: gnuradio.blocks.regenerate_bb +.. autoblock:: gnuradio.blocks.repack_bits_bb +.. autoblock:: gnuradio.blocks.repeat +.. autoblock:: gnuradio.blocks.rms_cf +.. autoblock:: gnuradio.blocks.rms_ff +.. autoblock:: gnuradio.blocks.rotator_cc +.. autoblock:: gnuradio.blocks.sample_and_hold_bb +.. autoblock:: gnuradio.blocks.sample_and_hold_ff +.. autoblock:: gnuradio.blocks.sample_and_hold_ii +.. autoblock:: gnuradio.blocks.sample_and_hold_ss +.. autoblock:: gnuradio.blocks.short_to_char +.. autoblock:: gnuradio.blocks.short_to_float +.. autoblock:: gnuradio.blocks.skiphead +.. autoblock:: gnuradio.blocks.socket_pdu +.. autoblock:: gnuradio.blocks.stream_mux +.. autoblock:: gnuradio.blocks.stream_to_streams +.. autoblock:: gnuradio.blocks.stream_to_tagged_stream +.. autoblock:: gnuradio.blocks.stream_to_vector +.. autoblock:: gnuradio.blocks.streams_to_stream +.. autoblock:: gnuradio.blocks.streams_to_vector +.. autoblock:: gnuradio.blocks.stretch_ff +.. autoblock:: gnuradio.blocks.sub_cc +.. autoblock:: gnuradio.blocks.sub_ff +.. autoblock:: gnuradio.blocks.sub_ii +.. autoblock:: gnuradio.blocks.sub_ss +.. autoblock:: gnuradio.blocks.tag_debug +.. autoblock:: gnuradio.blocks.tag_gate +.. autoblock:: gnuradio.blocks.tagged_file_sink +.. autoblock:: gnuradio.blocks.tagged_stream_align +.. autoblock:: gnuradio.blocks.tagged_stream_multiply_length +.. autoblock:: gnuradio.blocks.tagged_stream_mux +.. autoblock:: gnuradio.blocks.tagged_stream_to_pdu +.. autoblock:: gnuradio.blocks.tags_strobe +.. autoblock:: gnuradio.blocks.threshold_ff +.. autoblock:: gnuradio.blocks.throttle +.. autoblock:: gnuradio.blocks.transcendental +.. autoblock:: gnuradio.blocks.tsb_vector_sink_b +.. autoblock:: gnuradio.blocks.tsb_vector_sink_c +.. autoblock:: gnuradio.blocks.tsb_vector_sink_f +.. autoblock:: gnuradio.blocks.tsb_vector_sink_i +.. autoblock:: gnuradio.blocks.tsb_vector_sink_s +.. autoblock:: gnuradio.blocks.tuntap_pdu +.. autoblock:: gnuradio.blocks.uchar_to_float +.. autoblock:: gnuradio.blocks.udp_sink +.. autoblock:: gnuradio.blocks.udp_source +.. autoblock:: gnuradio.blocks.unpack_k_bits_bb +.. autoblock:: gnuradio.blocks.unpacked_to_packed_bb +.. autoblock:: gnuradio.blocks.unpacked_to_packed_ii +.. autoblock:: gnuradio.blocks.unpacked_to_packed_ss +.. autoblock:: gnuradio.blocks.vco_c +.. autoblock:: gnuradio.blocks.vco_f +.. autoblock:: gnuradio.blocks.vector_insert_b +.. autoblock:: gnuradio.blocks.vector_insert_c +.. autoblock:: gnuradio.blocks.vector_insert_f +.. autoblock:: gnuradio.blocks.vector_insert_i +.. autoblock:: gnuradio.blocks.vector_insert_s +.. autoblock:: gnuradio.blocks.vector_map +.. autoblock:: gnuradio.blocks.vector_sink_b +.. autoblock:: gnuradio.blocks.vector_sink_c +.. autoblock:: gnuradio.blocks.vector_sink_f +.. autoblock:: gnuradio.blocks.vector_sink_i +.. autoblock:: gnuradio.blocks.vector_sink_s +.. autoblock:: gnuradio.blocks.vector_source_b +.. autoblock:: gnuradio.blocks.vector_source_c +.. autoblock:: gnuradio.blocks.vector_source_f +.. autoblock:: gnuradio.blocks.vector_source_i +.. autoblock:: gnuradio.blocks.vector_source_s +.. autoblock:: gnuradio.blocks.vector_to_stream +.. autoblock:: gnuradio.blocks.vector_to_streams +.. autoblock:: gnuradio.blocks.wavfile_sink +.. autoblock:: gnuradio.blocks.wavfile_source +.. autoblock:: gnuradio.blocks.xor_bb +.. autoblock:: gnuradio.blocks.xor_ii +.. autoblock:: gnuradio.blocks.xor_ss diff --git a/docs/sphinx/source/channels.rst b/docs/sphinx/source/channels.rst index 4013b57938..cd2fb368b2 100644 --- a/docs/sphinx/source/channels.rst +++ b/docs/sphinx/source/channels.rst @@ -1,8 +1,12 @@ gnuradio.channels ================= -.. automodule:: gnuradio.channels - -.. autoblock:: gnuradio.channels.channel_model -.. autoblock:: gnuradio.channels.fading_model - +.. autoclass:: gnuradio.channels.amp_bal +.. autoclass:: gnuradio.channels.conj_fs_iqcorr +.. autoclass:: gnuradio.channels.distortion_2_gen +.. autoclass:: gnuradio.channels.distortion_3_gen +.. autoclass:: gnuradio.channels.impairments +.. autoclass:: gnuradio.channels.iqbal_gen +.. autoclass:: gnuradio.channels.phase_bal +.. autoclass:: gnuradio.channels.phase_noise_gen +.. autoclass:: gnuradio.channels.quantizer diff --git a/docs/sphinx/source/channels_blocks.rst b/docs/sphinx/source/channels_blocks.rst new file mode 100644 index 0000000000..f8213aa26e --- /dev/null +++ b/docs/sphinx/source/channels_blocks.rst @@ -0,0 +1,12 @@ +gnuradio.channels +================= + +.. automodule:: gnuradio.channels + +.. autoblock:: gnuradio.channels.channel_model +.. autoblock:: gnuradio.channels.channel_model2 +.. autoblock:: gnuradio.channels.fading_model +.. autoblock:: gnuradio.channels.selective_fading_model +.. autoblock:: gnuradio.channels.dynamic_channel_model +.. autoblock:: gnuradio.channels.cfo_model +.. autoblock:: gnuradio.channels.sro_model diff --git a/docs/sphinx/source/comedi.rst b/docs/sphinx/source/comedi_blocks.rst index 2bed3683a2..570be745df 100644 --- a/docs/sphinx/source/comedi.rst +++ b/docs/sphinx/source/comedi_blocks.rst @@ -3,6 +3,5 @@ gnuradio.comedi .. automodule:: gnuradio.comedi -.. autoblock:: gnuradio.comedi.source_s .. autoblock:: gnuradio.comedi.sink_s - +.. autoblock:: gnuradio.comedi.source_s diff --git a/docs/sphinx/source/digital.rst b/docs/sphinx/source/digital.rst new file mode 100644 index 0000000000..e15c9166d9 --- /dev/null +++ b/docs/sphinx/source/digital.rst @@ -0,0 +1,116 @@ +gnuradio.digital +================ + +.. autoclass:: gnuradio.digital.constellation +.. autoclass:: gnuradio.digital.lfsr +.. autoclass:: gnuradio.digital.mpsk_snr_est +.. autoclass:: gnuradio.digital.simple_framer +.. autoclass:: gnuradio.digital.bpsk_mod +.. autoclass:: gnuradio.digital.bpsk_demod +.. autoclass:: gnuradio.digital.dbpsk_mod +.. autoclass:: gnuradio.digital.dbpsk_demod +.. autofunction:: gnuradio.digital.crc32 +.. autofunction:: gnuradio.digital.update_crc32 +.. autofunction:: gnuradio.digital.constellation_map_generator +.. autoclass:: gnuradio.digital.cpm_mod +.. autofunction:: gnuradio.digital.gen_and_append_crc32 +.. autofunction:: gnuradio.digital.check_crc32 +.. autoclass:: gnuradio.digital.generic_mod +.. autoclass:: gnuradio.digital.generic_demod +.. autoclass:: gnuradio.digital.gfsk_mod +.. autoclass:: gnuradio.digital.gfsk_demod +.. autoclass:: gnuradio.digital.gmsk_mod +.. autoclass:: gnuradio.digital.gmsk_demod +.. autofunction:: gnuradio.digital.type_1_mods +.. autofunction:: gnuradio.digital.add_type_1_mod +.. autofunction:: gnuradio.digital.type_1_demods +.. autofunction:: gnuradio.digital.add_type_1_demod +.. autofunction:: gnuradio.digital.type_1_constellations +.. autofunction:: gnuradio.digital.add_type_1_constellation +.. autofunction:: gnuradio.digital.extract_kwargs_from_options +.. autofunction:: gnuradio.digital.extract_kwargs_from_options_for_class +.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_packed_binary_string_to_1_0_string +.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_1_0_string_to_packed_binary_string +.. autofunction:: gnuradio.digital.ofdm_packet_utils.is_1_0_string +.. autofunction:: gnuradio.digital.ofdm_packet_utils.string_to_hex_list +.. autofunction:: gnuradio.digital.ofdm_packet_utils.whiten +.. autofunction:: gnuradio.digital.ofdm_packet_utils.dewhiten +.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_header +.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_packet +.. autofunction:: gnuradio.digital.ofdm_packet_utils.unmake_packet +.. autoclass:: gnuradio.digital.ofdm_mod +.. autoclass:: gnuradio.digital.ofdm_demod +.. autoclass:: gnuradio.digital.ofdm_receiver +.. autoclass:: gnuradio.digital.ofdm_sync_fixed +.. autoclass:: gnuradio.digital.ofdm_sync_ml +.. autoclass:: gnuradio.digital.ofdm_sync_pnac +.. autoclass:: gnuradio.digital.ofdm_sync_pn +.. autoclass:: gnuradio.digital.ofdm_tx +.. autoclass:: gnuradio.digital.ofdm_rx +.. autofunction:: gnuradio.digital.packet_utils.conv_packed_binary_string_to_1_0_string +.. autofunction:: gnuradio.digital.packet_utils.conv_1_0_string_to_packed_binary_string +.. autofunction:: gnuradio.digital.packet_utils.is_1_0_string +.. autofunction:: gnuradio.digital.packet_utils.string_to_hex_list +.. autofunction:: gnuradio.digital.packet_utils.whiten +.. autofunction:: gnuradio.digital.packet_utils.dewhiten +.. autofunction:: gnuradio.digital.packet_utils.make_header +.. autofunction:: gnuradio.digital.packet_utils.make_packet +.. autofunction:: gnuradio.digital.packet_utils.unmake_packet +.. autoclass:: gnuradio.digital.mod_pkts +.. autoclass:: gnuradio.digital.demod_pkts +.. autofunction:: gnuradio.digital.psk_2_0x0 +.. autofunction:: gnuradio.digital.psk_2_0x1 +.. autofunction:: gnuradio.digital.sd_psk_2_0x0 +.. autofunction:: gnuradio.digital.sd_psk_2_0x1 +.. autofunction:: gnuradio.digital.psk_4_0x0_0_1 +.. autofunction:: gnuradio.digital.psk_4_0x1_0_1 +.. autofunction:: gnuradio.digital.psk_4_0x2_0_1 +.. autofunction:: gnuradio.digital.psk_4_0x3_0_1 +.. autofunction:: gnuradio.digital.psk_4_0x0_1_0 +.. autofunction:: gnuradio.digital.psk_4_0x1_1_0 +.. autofunction:: gnuradio.digital.psk_4_0x2_1_0 +.. autofunction:: gnuradio.digital.psk_4_0x3_1_0 +.. autofunction:: gnuradio.digital.sd_psk_4_0x0_0_1 +.. autofunction:: gnuradio.digital.sd_psk_4_0x1_0_1 +.. autofunction:: gnuradio.digital.sd_psk_4_0x2_0_1 +.. autofunction:: gnuradio.digital.sd_psk_4_0x3_0_1 +.. autofunction:: gnuradio.digital.sd_psk_4_0x0_1_0 +.. autofunction:: gnuradio.digital.sd_psk_4_0x1_1_0 +.. autofunction:: gnuradio.digital.sd_psk_4_0x2_1_0 +.. autofunction:: gnuradio.digital.sd_psk_4_0x3_1_0 +.. autofunction:: gnuradio.digital.psk_constellation +.. autoclass:: gnuradio.digital.psk_mod +.. autoclass:: gnuradio.digital.psk_demod +.. autofunction:: gnuradio.digital.qam_16_0x0_0_1_2_3 +.. autofunction:: gnuradio.digital.qam_16_0x1_0_1_2_3 +.. autofunction:: gnuradio.digital.qam_16_0x2_0_1_2_3 +.. autofunction:: gnuradio.digital.qam_16_0x3_0_1_2_3 +.. autofunction:: gnuradio.digital.qam_16_0x0_1_0_2_3 +.. autofunction:: gnuradio.digital.qam_16_0x1_1_0_2_3 +.. autofunction:: gnuradio.digital.qam_16_0x2_1_0_2_3 +.. autofunction:: gnuradio.digital.qam_16_0x3_1_0_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x0_0_1_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x1_0_1_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x2_0_1_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x3_0_1_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x0_1_0_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x1_1_0_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x2_1_0_2_3 +.. autofunction:: gnuradio.digital.sd_qam_16_0x3_1_0_2_3 +.. autofunction:: gnuradio.digital.qam32_holeinside_constellation +.. autofunction:: gnuradio.digital.make_differential_constellation +.. autofunction:: gnuradio.digital.make_non_differential_constellation +.. autofunction:: gnuradio.digital.qam_constellation +.. autoclass:: gnuradio.digital.qam_mod +.. autoclass:: gnuradio.digital.qam_demod +.. autofunction:: gnuradio.digital.qpsk_constellation +.. autoclass:: gnuradio.digital.qpsk_mod +.. autoclass:: gnuradio.digital.qpsk_demod +.. autofunction:: gnuradio.digital.dqpsk_constellation +.. autoclass:: gnuradio.digital.dqpsk_mod +.. autoclass:: gnuradio.digital.dqpsk_demod +.. autofunction:: gnuradio.digital.soft_dec_table_generator +.. autofunction:: gnuradio.digital.soft_dec_table +.. autofunction:: gnuradio.digital.calc_soft_dec_from_table +.. autofunction:: gnuradio.digital.calc_soft_dec +.. autofunction:: gnuradio.digital.show_table diff --git a/docs/sphinx/source/digital/blocks.rst b/docs/sphinx/source/digital/blocks.rst deleted file mode 100644 index 2c5218c372..0000000000 --- a/docs/sphinx/source/digital/blocks.rst +++ /dev/null @@ -1,69 +0,0 @@ -gnuradio.digital: Signal Processing Blocks -========================================== - -.. autoblock:: gnuradio.digital.fll_band_edge_cc -.. autoblock:: gnuradio.digital.kurtotic_equalizer_cc -.. autoblock:: gnuradio.digital.lms_dd_equalizer_cc -.. autoblock:: gnuradio.digital.mpsk_receiver_cc -.. autoblock:: gnuradio.digital.mpsk_snr_est_cc -.. autoblock:: gnuradio.digital.clock_recovery_mm_cc -.. autoblock:: gnuradio.digital.clock_recovery_mm_ff -.. autoblock:: gnuradio.digital.constellation_decoder_cb -.. autoblock:: gnuradio.digital.constellation_receiver_cb -.. autoblock:: gnuradio.digital.correlate_access_code_bb -.. autoblock:: gnuradio.digital.costas_loop_cc -.. autoblock:: gnuradio.digital.cma_equalizer_cc -.. autoblock:: gnuradio.digital.binary_slicer_fb -.. autoblock:: gnuradio.digital.gmskmod_bc -.. autoblock:: gnuradio.digital.probe_mpsk_snr_est_c -.. autoblock:: gnuradio.digital.cpmmod_bc -.. autoblock:: gnuradio.digital.glfsr_source_b -.. autoblock:: gnuradio.digital.glfsr_source_f -.. autoblock:: gnuradio.digital.framer_sink_1 -.. autoblock:: gnuradio.digital.framer_sink_1 -.. autoblock:: gnuradio.digital.additive_scrambler_bb -.. autoblock:: gnuradio.digital.descrambler_bb -.. autoblock:: gnuradio.digital.diff_decoder_bb -.. autoblock:: gnuradio.digital.diff_encoder_bb -.. autoblock:: gnuradio.digital.map_bb -.. autoblock:: gnuradio.digital.scrambler_bb -.. autoblock:: gnuradio.digital.pn_correlator_cc -.. autoblock:: gnuradio.digital.simple_framer -.. autoblock:: gnuradio.digital.chunks_to_symbols_bc -.. autoblock:: gnuradio.digital.chunks_to_symbols_bf -.. autoblock:: gnuradio.digital.chunks_to_symbols_ic -.. autoblock:: gnuradio.digital.chunks_to_symbols_if -.. autoblock:: gnuradio.digital.chunks_to_symbols_sc -.. autoblock:: gnuradio.digital.chunks_to_symbols_sf -.. autopyblock:: gnuradio.digital.generic_demod -.. autopyblock:: gnuradio.digital.generic_mod -.. autopyblock:: gnuradio.digital.bpsk.dbpsk_demod -.. autopyblock:: gnuradio.digital.bpsk.dbpsk_mod -.. autopyblock:: gnuradio.digital.qpsk.dqpsk_demod -.. autopyblock:: gnuradio.digital.qpsk.dqpsk_mod -.. autopyblock:: gnuradio.digital.gmsk.gmsk_demod -.. autopyblock:: gnuradio.digital.gmsk.gmsk_mod -.. autopyblock:: gnuradio.digital.bpsk.bpsk_demod -.. autopyblock:: gnuradio.digital.bpsk.bpsk_mod -.. autopyblock:: gnuradio.digital.psk.psk_demod -.. autopyblock:: gnuradio.digital.psk.psk_mod -.. autopyblock:: gnuradio.digital.qam.qam_demod -.. autopyblock:: gnuradio.digital.qam.qam_mod -.. autopyblock:: gnuradio.digital.qpsk.qpsk_demod -.. autopyblock:: gnuradio.digital.qpsk.qpsk_mod -.. autopyblock:: gnuradio.digital.cpm.cpm_mod -.. autopyblock:: gnuradio.digital.pkt.mod_pkts -.. autopyblock:: gnuradio.digital.pkt.demod_pkts -.. autopyblock:: gnuradio.digital.ofdm_cyclic_prefixer -.. autopyblock:: gnuradio.digital.ofdm_frame_acquisition -.. autopyblock:: gnuradio.digital.ofdm_frame_sink -.. autopyblock:: gnuradio.digital.ofdm_insert_preamble -.. autopyblock:: gnuradio.digital.ofdm_mapper_bcv -.. autopyblock:: gnuradio.digital.ofdm_mod -.. autopyblock:: gnuradio.digital.ofdm_demod -.. autopyblock:: gnuradio.digital.ofdm_receiver -.. autopyblock:: gnuradio.digital.ofdm_sampler -.. autopyblock:: gnuradio.digital.ofdm_sync_fixed -.. autopyblock:: gnuradio.digital.ofdm_sync_ml -.. autopyblock:: gnuradio.digital.ofdm_sync_pn -.. autopyblock:: gnuradio.digital.ofdm_sync_pnac diff --git a/docs/sphinx/source/digital/constellations.rst b/docs/sphinx/source/digital/constellations.rst deleted file mode 100644 index 3fa02613ae..0000000000 --- a/docs/sphinx/source/digital/constellations.rst +++ /dev/null @@ -1,13 +0,0 @@ -gnuradio.digital: Constellations -================================ - -.. autofunction:: gnuradio.digital.constellation_8psk -.. autofunction:: gnuradio.digital.constellation_bpsk -.. autofunction:: gnuradio.digital.constellation_calcdist -.. autofunction:: gnuradio.digital.constellation_dqpsk -.. autofunction:: gnuradio.digital.constellation_psk -.. autofunction:: gnuradio.digital.constellation_qpsk -.. autofunction:: gnuradio.digital.constellation_rect -.. autofunction:: gnuradio.digital.qpsk.qpsk_constellation -.. autofunction:: gnuradio.digital.psk.psk_constellation -.. autofunction:: gnuradio.digital.qam.qam_constellation diff --git a/docs/sphinx/source/digital/index.rst b/docs/sphinx/source/digital/index.rst deleted file mode 100644 index adf8065aca..0000000000 --- a/docs/sphinx/source/digital/index.rst +++ /dev/null @@ -1,151 +0,0 @@ -gnuradio.digital -================ - -.. automodule:: gnuradio.digital - -Signal Processing Blocks ------------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.fll_band_edge_cc - gnuradio.digital.kurtotic_equalizer_cc - gnuradio.digital.lms_dd_equalizer_cc - gnuradio.digital.mpsk_receiver_cc - gnuradio.digital.mpsk_snr_est_cc - gnuradio.digital.clock_recovery_mm_cc - gnuradio.digital.clock_recovery_mm_ff - gnuradio.digital.constellation_decoder_cb - gnuradio.digital.constellation_receiver_cb - gnuradio.digital.correlate_access_code_bb - gnuradio.digital.costas_loop_cc - gnuradio.digital.cma_equalizer_cc - gnuradio.digital.binary_slicer_fb - gnuradio.digital.gmskmod_bc - gnuradio.digital.probe_mpsk_snr_est_c - gnuradio.digital.cpmmod_bc - gnuradio.digital.glfsr_source_b - gnuradio.digital.glfsr_source_f - gnuradio.digital.framer_sink_1 - gnuradio.digital.additive_scrambler_bb - gnuradio.digital.descrambler_bb - gnuradio.digital.diff_decoder_bb - gnuradio.digital.diff_encoder_bb - gnuradio.digital.map_bb - gnuradio.digital.scrambler_bb - gnuradio.digital.pn_correlator_cc - gnuradio.digital.simple_framer - gnuradio.digital.chunks_to_symbols_bc - gnuradio.digital.chunks_to_symbols_bf - gnuradio.digital.chunks_to_symbols_ic - gnuradio.digital.chunks_to_symbols_if - gnuradio.digital.chunks_to_symbols_sc - gnuradio.digital.chunks_to_symbols_sf - gnuradio.digital.generic_demod - gnuradio.digital.generic_mod - gnuradio.digital.bpsk.dbpsk_demod - gnuradio.digital.bpsk.dbpsk_mod - gnuradio.digital.qpsk.dqpsk_demod - gnuradio.digital.qpsk.dqpsk_mod - gnuradio.digital.gmsk.gmsk_demod - gnuradio.digital.gmsk.gmsk_mod - gnuradio.digital.bpsk.bpsk_demod - gnuradio.digital.bpsk.bpsk_mod - gnuradio.digital.psk.psk_demod - gnuradio.digital.psk.psk_mod - gnuradio.digital.qam.qam_demod - gnuradio.digital.qam.qam_mod - gnuradio.digital.qpsk.qpsk_demod - gnuradio.digital.qpsk.qpsk_mod - gnuradio.digital.cpm.cpm_mod - gnuradio.digital.pkt.mod_pkts - gnuradio.digital.pkt.demod_pkts - gnuradio.digital.ofdm_cyclic_prefixer - gnuradio.digital.ofdm_frame_acquisition - gnuradio.digital.ofdm_frame_sink - gnuradio.digital.ofdm_insert_preamble - gnuradio.digital.ofdm_mapper_bcv - gnuradio.digital.ofdm_mod - gnuradio.digital.ofdm_demod - gnuradio.digital.ofdm_receiver - gnuradio.digital.ofdm_sampler - gnuradio.digital.ofdm_sync_fixed - gnuradio.digital.ofdm_sync_ml - gnuradio.digital.ofdm_sync_pn - gnuradio.digital.ofdm_sync_pnac - -Constellations --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.constellation_8psk - gnuradio.digital.constellation_bpsk - gnuradio.digital.constellation_calcdist - gnuradio.digital.constellation_dqpsk - gnuradio.digital.constellation_psk - gnuradio.digital.constellation_qpsk - gnuradio.digital.constellation_qpsk - gnuradio.digital.constellation_rect - gnuradio.digital.qpsk.qpsk_constellation - gnuradio.digital.psk.psk_constellation - gnuradio.digital.qam.qam_constellation - -Modulation Utilties -------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.utils.gray_code.gray_code - gnuradio.digital.modulation_utils.add_type_1_constellation - gnuradio.digital.modulation_utils.add_type_1_demod - gnuradio.digital.modulation_utils.add_type_1_mod - gnuradio.digital.modulation_utils.type_1_constellations - gnuradio.digital.modulation_utils.type_1_demods - gnuradio.digital.modulation_utils.type_1_mods - -.. gnuradio.digital.utils.mod_codes.GRAY_CODE -.. gnuradio.digital.utils.mod_codes.NO_CODE - -Packet Utilities ----------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.packet_utils.conv_1_0_string_to_packed_binary_string - gnuradio.digital.packet_utils.conv_packed_binary_string_to_1_0_string - gnuradio.digital.packet_utils.default_access_code - gnuradio.digital.packet_utils.dewhiten - gnuradio.digital.packet_utils.is_1_0_string - gnuradio.digital.packet_utils.make_header - gnuradio.digital.packet_utils.make_packet - gnuradio.digital.packet_utils.preamble - gnuradio.digital.packet_utils.random_mask_tuple - gnuradio.digital.packet_utils.random_mask_vec8 - gnuradio.digital.packet_utils.string_to_hex_list - gnuradio.digital.packet_utils.unmake_packet - gnuradio.digital.packet_utils.whiten - gnuradio.digital.crc.check_crc32 - gnuradio.digital.crc.gen_and_append_crc32 - -OFDM Packet Utilities ---------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.ofdm_packet_utils.conv_1_0_string_to_packed_binary_string - gnuradio.digital.ofdm_packet_utils.conv_packed_binary_string_to_1_0_string - gnuradio.digital.ofdm_packet_utils.dewhiten - gnuradio.digital.ofdm_packet_utils.is_1_0_string - gnuradio.digital.ofdm_packet_utils.make_header - gnuradio.digital.ofdm_packet_utils.make_packet - gnuradio.digital.ofdm_packet_utils.random_mask_tuple - gnuradio.digital.ofdm_packet_utils.random_mask_vec8 - gnuradio.digital.ofdm_packet_utils.string_to_hex_list - gnuradio.digital.ofdm_packet_utils.unmake_packet - gnuradio.digital.ofdm_packet_utils.whiten diff --git a/docs/sphinx/source/digital/ofdm.rst b/docs/sphinx/source/digital/ofdm.rst deleted file mode 100644 index 8680503f26..0000000000 --- a/docs/sphinx/source/digital/ofdm.rst +++ /dev/null @@ -1,14 +0,0 @@ -gnuradio.digital: OFDM Packet Utilities -======================================= - -.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_1_0_string_to_packed_binary_string -.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_packed_binary_string_to_1_0_string -.. autofunction:: gnuradio.digital.ofdm_packet_utils.dewhiten -.. autofunction:: gnuradio.digital.ofdm_packet_utils.is_1_0_string -.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_header -.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_packet -.. autofunction:: gnuradio.digital.ofdm_packet_utils.random_mask_tuple -.. autofunction:: gnuradio.digital.ofdm_packet_utils.random_mask_vec8 -.. autofunction:: gnuradio.digital.ofdm_packet_utils.string_to_hex_list -.. autofunction:: gnuradio.digital.ofdm_packet_utils.unmake_packet -.. autofunction:: gnuradio.digital.ofdm_packet_utils.whiten diff --git a/docs/sphinx/source/digital/pkt_utils.rst b/docs/sphinx/source/digital/pkt_utils.rst deleted file mode 100644 index 112e103a2f..0000000000 --- a/docs/sphinx/source/digital/pkt_utils.rst +++ /dev/null @@ -1,18 +0,0 @@ -gnuradio.digital: Packet Utilities -================================== - -.. autofunction:: gnuradio.digital.packet_utils.conv_1_0_string_to_packed_binary_string -.. autofunction:: gnuradio.digital.packet_utils.conv_packed_binary_string_to_1_0_string -.. data:: gnuradio.digital.packet_utils.default_access_code -.. autofunction:: gnuradio.digital.packet_utils.dewhiten -.. autofunction:: gnuradio.digital.packet_utils.is_1_0_string -.. autofunction:: gnuradio.digital.packet_utils.make_header -.. autofunction:: gnuradio.digital.packet_utils.make_packet -.. data:: gnuradio.digital.packet_utils.preamble -.. autofunction:: gnuradio.digital.packet_utils.random_mask_tuple -.. autofunction:: gnuradio.digital.packet_utils.random_mask_vec8 -.. autofunction:: gnuradio.digital.packet_utils.string_to_hex_list -.. autofunction:: gnuradio.digital.packet_utils.unmake_packet -.. autofunction:: gnuradio.digital.packet_utils.whiten -.. autofunction:: gnuradio.digital.crc.check_crc32 -.. autofunction:: gnuradio.digital.crc.gen_and_append_crc32 diff --git a/docs/sphinx/source/digital/utilities.rst b/docs/sphinx/source/digital/utilities.rst deleted file mode 100644 index 7a08725a58..0000000000 --- a/docs/sphinx/source/digital/utilities.rst +++ /dev/null @@ -1,12 +0,0 @@ -gnuradio.digital: Modulation Utilities -====================================== - -.. autofunction:: gnuradio.digital.utils.gray_code.gray_code -.. data:: gnuradio.digital.utils.mod_codes.GRAY_CODE -.. data:: gnuradio.digital.utils.mod_codes.NO_CODE -.. autofunction:: gnuradio.digital.modulation_utils.add_type_1_constellation -.. autofunction:: gnuradio.digital.modulation_utils.add_type_1_demod -.. autofunction:: gnuradio.digital.modulation_utils.add_type_1_mod -.. data:: gnuradio.digital.modulation_utils.type_1_constellations -.. data:: gnuradio.digital.modulation_utils.type_1_demods -.. data:: gnuradio.digital.modulation_utils.type_1_mods diff --git a/docs/sphinx/source/digital_blocks.rst b/docs/sphinx/source/digital_blocks.rst new file mode 100644 index 0000000000..1dfd017069 --- /dev/null +++ b/docs/sphinx/source/digital_blocks.rst @@ -0,0 +1,75 @@ +gnuradio.digital +================= + +.. automodule:: gnuradio.digital + +.. autoblock:: gnuradio.digital.additive_scrambler_bb +.. autoblock:: gnuradio.digital.binary_slicer_fb +.. autoblock:: gnuradio.digital.burst_shaper_cc +.. autoblock:: gnuradio.digital.burst_shaper_ff +.. autoblock:: gnuradio.digital.chunks_to_symbols_bc +.. autoblock:: gnuradio.digital.chunks_to_symbols_bf +.. autoblock:: gnuradio.digital.chunks_to_symbols_ic +.. autoblock:: gnuradio.digital.chunks_to_symbols_if +.. autoblock:: gnuradio.digital.chunks_to_symbols_sc +.. autoblock:: gnuradio.digital.chunks_to_symbols_sf +.. autoblock:: gnuradio.digital.clock_recovery_mm_cc +.. autoblock:: gnuradio.digital.clock_recovery_mm_ff +.. autoblock:: gnuradio.digital.cma_equalizer_cc +.. autoblock:: gnuradio.digital.constellation_decoder_cb +.. autoblock:: gnuradio.digital.constellation_receiver_cb +.. autoblock:: gnuradio.digital.constellation_soft_decoder_cf +.. autoblock:: gnuradio.digital.correlate_access_code_bb +.. autoblock:: gnuradio.digital.correlate_access_code_bb_ts +.. autoblock:: gnuradio.digital.correlate_access_code_ff_ts +.. autoblock:: gnuradio.digital.correlate_access_code_tag_bb +.. autoblock:: gnuradio.digital.correlate_and_sync_cc +.. autoblock:: gnuradio.digital.corr_est_cc +.. autoblock:: gnuradio.digital.costas_loop_cc +.. autoblock:: gnuradio.digital.cpmmod_bc +.. autoblock:: gnuradio.digital.crc32_async_bb +.. autoblock:: gnuradio.digital.crc32_bb +.. autoblock:: gnuradio.digital.descrambler_bb +.. autoblock:: gnuradio.digital.diff_decoder_bb +.. autoblock:: gnuradio.digital.diff_encoder_bb +.. autoblock:: gnuradio.digital.diff_phasor_cc +.. autoblock:: gnuradio.digital.fll_band_edge_cc +.. autoblock:: gnuradio.digital.framer_sink_1 +.. autoblock:: gnuradio.digital.glfsr_source_b +.. autoblock:: gnuradio.digital.glfsr_source_f +.. autoblock:: gnuradio.digital.hdlc_deframer_bp +.. autoblock:: gnuradio.digital.hdlc_framer_pb +.. autoblock:: gnuradio.digital.header_payload_demux +.. autoblock:: gnuradio.digital.kurtotic_equalizer_cc +.. autoblock:: gnuradio.digital.lms_dd_equalizer_cc +.. autoblock:: gnuradio.digital.map_bb +.. autoblock:: gnuradio.digital.mpsk_receiver_cc +.. autoblock:: gnuradio.digital.mpsk_snr_est_cc +.. autoblock:: gnuradio.digital.msk_timing_recovery_cc +.. autoblock:: gnuradio.digital.ofdm_carrier_allocator_cvc +.. autoblock:: gnuradio.digital.ofdm_chanest_vcvc +.. autoblock:: gnuradio.digital.ofdm_cyclic_prefixer +.. autoblock:: gnuradio.digital.ofdm_equalizer_base +.. autoblock:: gnuradio.digital.ofdm_equalizer_simpledfe +.. autoblock:: gnuradio.digital.ofdm_equalizer_static +.. autoblock:: gnuradio.digital.ofdm_frame_acquisition +.. autoblock:: gnuradio.digital.ofdm_frame_equalizer_vcvc +.. autoblock:: gnuradio.digital.ofdm_frame_sink +.. autoblock:: gnuradio.digital.ofdm_insert_preamble +.. autoblock:: gnuradio.digital.ofdm_mapper_bcv +.. autoblock:: gnuradio.digital.ofdm_sampler +.. autoblock:: gnuradio.digital.ofdm_serializer_vcc +.. autoblock:: gnuradio.digital.ofdm_sync_sc_cfb +.. autoblock:: gnuradio.digital.packet_header_default +.. autoblock:: gnuradio.digital.packet_headergenerator_bb +.. autoblock:: gnuradio.digital.packet_header_ofdm +.. autoblock:: gnuradio.digital.packet_headerparser_b +.. autoblock:: gnuradio.digital.packet_sink +.. autoblock:: gnuradio.digital.pfb_clock_sync_ccf +.. autoblock:: gnuradio.digital.pfb_clock_sync_fff +.. autoblock:: gnuradio.digital.pn_correlator_cc +.. autoblock:: gnuradio.digital.probe_density_b +.. autoblock:: gnuradio.digital.probe_mpsk_snr_est_c +.. autoblock:: gnuradio.digital.scrambler_bb +.. autoblock:: gnuradio.digital.simple_correlator +.. autoblock:: gnuradio.digital.simple_framer diff --git a/docs/sphinx/source/dtv.rst b/docs/sphinx/source/dtv.rst new file mode 100644 index 0000000000..0cf9a50928 --- /dev/null +++ b/docs/sphinx/source/dtv.rst @@ -0,0 +1,4 @@ +gnuradio.dtv +============ + +.. automodule:: gnuradio.dtv diff --git a/docs/sphinx/source/dtv_blocks.rst b/docs/sphinx/source/dtv_blocks.rst new file mode 100644 index 0000000000..d20f0d075d --- /dev/null +++ b/docs/sphinx/source/dtv_blocks.rst @@ -0,0 +1,44 @@ +gnuradio.dtv +============ + +.. automodule:: gnuradio.dtv + +.. autoblock:: gnuradio.dtv.atsc_deinterleaver +.. autoblock:: gnuradio.dtv.atsc_depad +.. autoblock:: gnuradio.dtv.atsc_derandomizer +.. autoblock:: gnuradio.dtv.atsc_equalizer +.. autoblock:: gnuradio.dtv.atsc_field_sync_mux +.. autoblock:: gnuradio.dtv.atsc_fpll +.. autoblock:: gnuradio.dtv.atsc_fs_checker +.. autoblock:: gnuradio.dtv.atsc_interleaver +.. autoblock:: gnuradio.dtv.atsc_pad +.. autoblock:: gnuradio.dtv.atsc_randomizer +.. autoblock:: gnuradio.dtv.atsc_rs_decoder +.. autoblock:: gnuradio.dtv.atsc_rs_encoder +.. autoblock:: gnuradio.dtv.atsc_sync +.. autoblock:: gnuradio.dtv.atsc_trellis_encoder +.. autoblock:: gnuradio.dtv.atsc_viterbi_decoder +.. autoblock:: gnuradio.dtv.dvb_bbheader_bb +.. autoblock:: gnuradio.dtv.dvb_bbscrambler_bb +.. autoblock:: gnuradio.dtv.dvb_bch_bb +.. autoblock:: gnuradio.dtv.dvb_ldpc_bb +.. autoblock:: gnuradio.dtv.dvbs2_interleaver_bb +.. autoblock:: gnuradio.dtv.dvbs2_modulator_bc +.. autoblock:: gnuradio.dtv.dvbs2_physical_cc +.. autoblock:: gnuradio.dtv.dvbt2_cellinterleaver_cc +.. autoblock:: gnuradio.dtv.dvbt2_framemapper_cc +.. autoblock:: gnuradio.dtv.dvbt2_freqinterleaver_cc +.. autoblock:: gnuradio.dtv.dvbt2_interleaver_bb +.. autoblock:: gnuradio.dtv.dvbt2_miso_cc +.. autoblock:: gnuradio.dtv.dvbt2_modulator_bc +.. autoblock:: gnuradio.dtv.dvbt2_p1insertion_cc +.. autoblock:: gnuradio.dtv.dvbt2_paprtr_cc +.. autoblock:: gnuradio.dtv.dvbt2_pilotgenerator_cc +.. autoblock:: gnuradio.dtv.dvbt_bit_inner_interleaver +.. autoblock:: gnuradio.dtv.dvbt_convolutional_interleaver +.. autoblock:: gnuradio.dtv.dvbt_energy_dispersal +.. autoblock:: gnuradio.dtv.dvbt_inner_coder +.. autoblock:: gnuradio.dtv.dvbt_map +.. autoblock:: gnuradio.dtv.dvbt_reed_solomon_enc +.. autoblock:: gnuradio.dtv.dvbt_reference_signals +.. autoblock:: gnuradio.dtv.dvbt_symbol_inner_interleaver diff --git a/docs/sphinx/source/eng_notation/index.rst b/docs/sphinx/source/eng_notation/index.rst deleted file mode 100644 index f457754ac2..0000000000 --- a/docs/sphinx/source/eng_notation/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -gnuradio.eng_notation -===================== - -.. automodule:: gnuradio.eng_notation - -.. autofunction:: gnuradio.eng_notation.num_to_str -.. autofunction:: gnuradio.eng_notation.str_to_num - diff --git a/docs/sphinx/source/eng_option/index.rst b/docs/sphinx/source/eng_option/index.rst deleted file mode 100644 index b9119ee698..0000000000 --- a/docs/sphinx/source/eng_option/index.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.eng_option -=================== - -.. automodule:: gnuradio.eng_option - -.. autoclass:: gnuradio.eng_option.eng_option diff --git a/docs/sphinx/source/fcd.rst b/docs/sphinx/source/fcd_blocks.rst index 126ef9c916..8aed544c97 100644 --- a/docs/sphinx/source/fcd.rst +++ b/docs/sphinx/source/fcd_blocks.rst @@ -3,5 +3,4 @@ gnuradio.fcd .. automodule:: gnuradio.fcd -.. autoblock:: gnuradio.fcd.fcd_source_c - +.. autoblock:: gnuradio.fcd.source_c diff --git a/docs/sphinx/source/fec.rst b/docs/sphinx/source/fec.rst index 75de71911b..c8990c45ee 100644 --- a/docs/sphinx/source/fec.rst +++ b/docs/sphinx/source/fec.rst @@ -1,8 +1,31 @@ gnuradio.fec ============ -.. automodule:: gnuradio.fec - -.. autoblock:: gnuradio.fec.decode_ccsds_27_fb -.. autoblock:: gnuradio.fec.encode_ccsds_27_bb +.. autoclass:: gnuradio.fec.cc_decoder +.. autoclass:: gnuradio.fec.cc_encoder +.. autoclass:: gnuradio.fec.ccsds_encoder +.. autoclass:: gnuradio.fec.dummy_decoder +.. autoclass:: gnuradio.fec.dummy_encoder +.. autoclass:: gnuradio.fec.ldpc_decoder +.. autoclass:: gnuradio.fec.ldpc_encoder +.. autoclass:: gnuradio.fec.repetition_decoder +.. autoclass:: gnuradio.fec.repetition_encoder +.. autoclass:: gnuradio.fec.tpc_decoder +.. autoclass:: gnuradio.fec.tpc_encoder +.. autoclass:: gnuradio.fec.bercurve_generator +.. autofunction:: gnuradio.fec.bitreverse +.. autofunction:: gnuradio.fec.bitflip +.. autofunction:: gnuradio.fec.read_bitlist +.. autofunction:: gnuradio.fec.read_big_bitlist +.. autofunction:: gnuradio.fec.generate_symmetries +.. autoclass:: gnuradio.fec.capillary_threaded_decoder +.. autoclass:: gnuradio.fec.capillary_threaded_encoder +.. autoclass:: gnuradio.fec.extended_async_encoder +.. autoclass:: gnuradio.fec.extended_decoder +.. autoclass:: gnuradio.fec.extended_encoder +.. autoclass:: gnuradio.fec.extended_tagged_decoder +.. autoclass:: gnuradio.fec.extended_tagged_encoder +.. autoclass:: gnuradio.fec.fec_test +.. autoclass:: gnuradio.fec.threaded_decoder +.. autoclass:: gnuradio.fec.threaded_encoder diff --git a/docs/sphinx/source/fec_blocks.rst b/docs/sphinx/source/fec_blocks.rst new file mode 100644 index 0000000000..6e92a86a41 --- /dev/null +++ b/docs/sphinx/source/fec_blocks.rst @@ -0,0 +1,20 @@ +gnuradio.fec +============ + +.. automodule:: gnuradio.fec + +.. autoblock:: gnuradio.fec.async_decoder +.. autoblock:: gnuradio.fec.async_encoder +.. autoblock:: gnuradio.fec.ber_bf +.. autoblock:: gnuradio.fec.conv_bit_corr_bb +.. autoblock:: gnuradio.fec.decode_ccsds_27_fb +.. autoblock:: gnuradio.fec.decoder +.. autoblock:: gnuradio.fec.depuncture_bb +.. autoblock:: gnuradio.fec.encode_ccsds_27_bb +.. autoblock:: gnuradio.fec.encoder +.. autoblock:: gnuradio.fec.generic_decoder +.. autoblock:: gnuradio.fec.generic_encoder +.. autoblock:: gnuradio.fec.puncture_bb +.. autoblock:: gnuradio.fec.puncture_ff +.. autoblock:: gnuradio.fec.tagged_decoder +.. autoblock:: gnuradio.fec.tagged_encoder diff --git a/docs/sphinx/source/fft.rst b/docs/sphinx/source/fft.rst index 2db3d1f5cb..563a5c898f 100644 --- a/docs/sphinx/source/fft.rst +++ b/docs/sphinx/source/fft.rst @@ -1,31 +1,4 @@ gnuradio.fft ============ -.. automodule:: gnuradio.fft - -.. autoblock:: gnuradio.fft.fft_vcc -.. autoblock:: gnuradio.fft.fft_vfc -.. autoblock:: gnuradio.fft.goertzel_fc - -gnuradio.fft.window -=================== - -.. automodule:: gnuradio.fft.window - -.. autofunction:: gnuradio.fft.window.bartlett -.. autofunction:: gnuradio.fft.window.blackman2 -.. autofunction:: gnuradio.fft.window.blackman3 -.. autofunction:: gnuradio.fft.window.blackman4 -.. autofunction:: gnuradio.fft.window.blackmanharris -.. autofunction:: gnuradio.fft.window.coswindow -.. autofunction:: gnuradio.fft.window.exponential -.. autofunction:: gnuradio.fft.window.flattop -.. autofunction:: gnuradio.fft.window.hamming -.. autofunction:: gnuradio.fft.window.hanning -.. autofunction:: gnuradio.fft.window.kaiser -.. autofunction:: gnuradio.fft.window.nuttall -.. autofunction:: gnuradio.fft.window.nuttall_cfd -.. autofunction:: gnuradio.fft.window.parzen -.. autofunction:: gnuradio.fft.window.rectangular -.. autofunction:: gnuradio.fft.window.riemann -.. autofunction:: gnuradio.fft.window.welch +.. autoclass:: gnuradio.fft.window diff --git a/docs/sphinx/source/fft_blocks.rst b/docs/sphinx/source/fft_blocks.rst new file mode 100644 index 0000000000..3b226a20ba --- /dev/null +++ b/docs/sphinx/source/fft_blocks.rst @@ -0,0 +1,9 @@ +gnuradio.fft +============ + +.. automodule:: gnuradio.fft + +.. autoblock:: gnuradio.fft.ctrlport_probe_psd +.. autoblock:: gnuradio.fft.fft_vcc +.. autoblock:: gnuradio.fft.fft_vfc +.. autoblock:: gnuradio.fft.goertzel_fc diff --git a/docs/sphinx/source/filter.rst b/docs/sphinx/source/filter.rst new file mode 100644 index 0000000000..d9f2d9207a --- /dev/null +++ b/docs/sphinx/source/filter.rst @@ -0,0 +1,29 @@ +gnuradio.filter +=============== + +.. autoclass:: gnuradio.filter.filterbank.analysis_filterbank +.. autoclass:: gnuradio.filter.filterbank.synthesis_filterbank +.. autoclass:: gnuradio.filter.firdes +.. autofunction:: gnuradio.filter.pm_remez +.. autoclass:: gnuradio.filter.synthesis_filterbank +.. autoclass:: gnuradio.filter.analysis_filterbank +.. autoclass:: gnuradio.filter.freq_xlating_fft_filter_ccc +.. autofunction:: gnuradio.filter.optfir.low_pass +.. autofunction:: gnuradio.filter.optfir.band_pass +.. autofunction:: gnuradio.filter.optfir.complex_band_pass +.. autofunction:: gnuradio.filter.optfir.band_reject +.. autofunction:: gnuradio.filter.optfir.stopband_atten_to_dev +.. autofunction:: gnuradio.filter.optfir.passband_ripple_to_dev +.. autofunction:: gnuradio.filter.optfir.remezord +.. autofunction:: gnuradio.filter.optfir.lporder +.. autofunction:: gnuradio.filter.optfir.bporder +.. autoclass:: gnuradio.filter.pfb.channelizer_ccf +.. autoclass:: gnuradio.filter.pfb.interpolator_ccf +.. autoclass:: gnuradio.filter.pfb.decimator_ccf +.. autoclass:: gnuradio.filter.pfb.arb_resampler_ccf +.. autoclass:: gnuradio.filter.pfb.arb_resampler_fff +.. autoclass:: gnuradio.filter.pfb.arb_resampler_ccc +.. autoclass:: gnuradio.filter.pfb.channelizer_hier_ccf +.. autoclass:: gnuradio.filter.rational_resampler_fff +.. autoclass:: gnuradio.filter.rational_resampler_ccf +.. autoclass:: gnuradio.filter.rational_resampler_ccc diff --git a/docs/sphinx/source/filter/channelizers_blk.rst b/docs/sphinx/source/filter/channelizers_blk.rst deleted file mode 100644 index 920be42882..0000000000 --- a/docs/sphinx/source/filter/channelizers_blk.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.filter: Channelizers -============================= - -.. autoblock:: gnuradio.filter.pfb_channelizer_ccf -.. autoblock:: gnuradio.filter.pfb_decimator_ccf -.. autoblock:: gnuradio.filter.pfb_interpolator_ccf -.. autoblock:: gnuradio.filter.pfb_synthesizer_ccf
\ No newline at end of file diff --git a/docs/sphinx/source/filter/filter_blk.rst b/docs/sphinx/source/filter/filter_blk.rst deleted file mode 100644 index 5c85c6d00a..0000000000 --- a/docs/sphinx/source/filter/filter_blk.rst +++ /dev/null @@ -1,16 +0,0 @@ -gnuradio.filter: Filters -======================== - -.. autoblock:: gnuradio.filter.adaptive_fir_ccc -.. autoblock:: gnuradio.filter.adaptive_fir_ccf -.. autoblock:: gnuradio.filter.dc_blocker_cc -.. autoblock:: gnuradio.filter.dc_blocker_ff -.. autoblock:: gnuradio.filter.fft_filter_fff -.. autoblock:: gnuradio.filter.fft_filter_ccc -.. autoblock:: gnuradio.filter.filter_delay_fc -.. autoblock:: gnuradio.filter.hilbert_fc -.. autoblock:: gnuradio.filter.iir_filter_ffd -.. autopyblock:: gnuradio.filter.analysis_filterbank -.. autopyblock:: gnuradio.filter.synthesis_filterbank -.. autoblock:: gnuradio.filter.single_pole_iir_filter_cc -.. autoblock:: gnuradio.filter.single_pole_iir_filter_ff diff --git a/docs/sphinx/source/filter/filter_design.rst b/docs/sphinx/source/filter/filter_design.rst deleted file mode 100644 index 4a78156c5d..0000000000 --- a/docs/sphinx/source/filter/filter_design.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.filter: Digital Filter Design -====================================== - -.. autoclass:: gnuradio.filter.firdes diff --git a/docs/sphinx/source/filter/index.rst b/docs/sphinx/source/filter/index.rst deleted file mode 100644 index 2f1be277ad..0000000000 --- a/docs/sphinx/source/filter/index.rst +++ /dev/null @@ -1,56 +0,0 @@ -gnuradio.filter -=============== - -.. automodule:: gnuradio.filter - -Channelizers ------------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.pfb_channelizer_ccf - gnuradio.filter.pfb_decimator_ccf - gnuradio.filter.pfb_interpolator_ccf - gnuradio.filter.pfb_synthesizer_ccf - -Filters -------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.adaptive_fir_ccc - gnuradio.filter.adaptive_fir_ccf - gnuradio.filter.dc_blocker_cc - gnuradio.filter.dc_blocker_ff - gnuradio.filter.fft_filter_fff - gnuradio.filter.fft_filter_ccc - gnuradio.filter.filter_delay_fc - gnuradio.filter.hilbert_fc - gnuradio.filter.iir_filter_ffd - gnuradio.filter.analysis_filterbank - gnuradio.filter.synthesis_filterbank - gnuradio.filter.single_pole_iir_filter_cc - gnuradio.filter.single_pole_iir_filter_ff - -Resamplers ----------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.fractional_interpolator_cc - gnuradio.filter.fractional_interpolator_ff - gnuradio.filter.fractional_resampler_cc - gnuradio.filter.fractional_resampler_ff - gnuradio.filter.pfb_arb_resampler_ccf - gnuradio.filter.pfb_arb_resampler_fff - -Digital Filter Design ---------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.firdes diff --git a/docs/sphinx/source/filter/resamplers_blk.rst b/docs/sphinx/source/filter/resamplers_blk.rst deleted file mode 100644 index 348888659d..0000000000 --- a/docs/sphinx/source/filter/resamplers_blk.rst +++ /dev/null @@ -1,9 +0,0 @@ -gnuradio.filter: Resamplers -=========================== - -.. autoblock:: gnuradio.filter.fractional_interpolator_cc -.. autoblock:: gnuradio.filter.fractional_interpolator_ff -.. autoblock:: gnuradio.filter.fractional_resampler_cc -.. autoblock:: gnuradio.filter.fractional_resampler_ff -.. autoblock:: gnuradio.filter.pfb_arb_resampler_ccf -.. autoblock:: gnuradio.filter.pfb_arb_resampler_fff
\ No newline at end of file diff --git a/docs/sphinx/source/filter_blocks.rst b/docs/sphinx/source/filter_blocks.rst new file mode 100644 index 0000000000..1ad2705e7e --- /dev/null +++ b/docs/sphinx/source/filter_blocks.rst @@ -0,0 +1,55 @@ +gnuradio.filters +================ + +.. automodule:: gnuradio.filter + +.. autoblock:: gnuradio.filter.dc_blocker_cc +.. autoblock:: gnuradio.filter.dc_blocker_ff +.. autoblock:: gnuradio.filter.fft_filter_ccc +.. autoblock:: gnuradio.filter.fft_filter_ccf +.. autoblock:: gnuradio.filter.fft_filter_fff +.. autoblock:: gnuradio.filter.filter_delay_fc +.. autoblock:: gnuradio.filter.filterbank_vcvcf +.. autoblock:: gnuradio.filter.fir_filter_ccc +.. autoblock:: gnuradio.filter.fir_filter_ccf +.. autoblock:: gnuradio.filter.fir_filter_fcc +.. autoblock:: gnuradio.filter.fir_filter_fff +.. autoblock:: gnuradio.filter.fir_filter_fsf +.. autoblock:: gnuradio.filter.fir_filter_scc +.. autoblock:: gnuradio.filter.fractional_interpolator_cc +.. autoblock:: gnuradio.filter.fractional_interpolator_ff +.. autoblock:: gnuradio.filter.fractional_resampler_cc +.. autoblock:: gnuradio.filter.fractional_resampler_ff +.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_ccc +.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_ccf +.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_fcc +.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_fcf +.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_scc +.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_scf +.. autoblock:: gnuradio.filter.hilbert_fc +.. autoblock:: gnuradio.filter.iir_filter_ccc +.. autoblock:: gnuradio.filter.iir_filter_ccd +.. autoblock:: gnuradio.filter.iir_filter_ccf +.. autoblock:: gnuradio.filter.iir_filter_ccz +.. autoblock:: gnuradio.filter.iir_filter_ffd +.. autoblock:: gnuradio.filter.interp_fir_filter_ccc +.. autoblock:: gnuradio.filter.interp_fir_filter_ccf +.. autoblock:: gnuradio.filter.interp_fir_filter_fcc +.. autoblock:: gnuradio.filter.interp_fir_filter_fff +.. autoblock:: gnuradio.filter.interp_fir_filter_fsf +.. autoblock:: gnuradio.filter.interp_fir_filter_scc +.. autoblock:: gnuradio.filter.pfb_arb_resampler_ccc +.. autoblock:: gnuradio.filter.pfb_arb_resampler_ccf +.. autoblock:: gnuradio.filter.pfb_arb_resampler_fff +.. autoblock:: gnuradio.filter.pfb_channelizer_ccf +.. autoblock:: gnuradio.filter.pfb_decimator_ccf +.. autoblock:: gnuradio.filter.pfb_interpolator_ccf +.. autoblock:: gnuradio.filter.pfb_synthesizer_ccf +.. autoblock:: gnuradio.filter.rational_resampler_base_ccc +.. autoblock:: gnuradio.filter.rational_resampler_base_ccf +.. autoblock:: gnuradio.filter.rational_resampler_base_fcc +.. autoblock:: gnuradio.filter.rational_resampler_base_fff +.. autoblock:: gnuradio.filter.rational_resampler_base_fsf +.. autoblock:: gnuradio.filter.rational_resampler_base_scc +.. autoblock:: gnuradio.filter.single_pole_iir_filter_cc +.. autoblock:: gnuradio.filter.single_pole_iir_filter_ff diff --git a/docs/sphinx/source/gr/contents.rst b/docs/sphinx/source/gr/contents.rst deleted file mode 100644 index a999a73ea8..0000000000 --- a/docs/sphinx/source/gr/contents.rst +++ /dev/null @@ -1,18 +0,0 @@ -gnuradio.gr -=========== - -.. autoclass:: gnuradio.gr.top_block -.. autoclass:: gnuradio.gr.hier_block2 -.. autofunction:: gnuradio.gr.block_detail -.. autofunction:: gnuradio.gr.buffer -.. autofunction:: gnuradio.gr.dispatcher -.. autofunction:: gnuradio.gr.single_threaded_scheduler -.. autofunction:: gnuradio.gr.prefs -.. autofunction:: gnuradio.gr.message -.. autofunction:: gnuradio.gr.msg_queue -.. autofunction:: gnuradio.gr.enable_realtime_scheduling -.. autofunction:: gnuradio.gr.feval_dd -.. autofunction:: gnuradio.gr.feval_cc -.. autofunction:: gnuradio.gr.feval_ll -.. autofunction:: gnuradio.gr.feval - diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst deleted file mode 100644 index b3e341f47b..0000000000 --- a/docs/sphinx/source/gr/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -gnuradio.gr -=========== - -.. automodule:: gnuradio.gr - -.. autosummary:: - :nosignatures: - - gnuradio.gr.top_block - gnuradio.gr.hier_block2 - gnuradio.gr.block_detail - gnuradio.gr.buffer - gnuradio.gr.dispatcher - gnuradio.gr.single_threaded_scheduler - gnuradio.gr.prefs - gnuradio.gr.message - gnuradio.gr.msg_queue - gnuradio.gr.enable_realtime_scheduling - gnuradio.gr.feval_dd - gnuradio.gr.feval_cc - gnuradio.gr.feval_ll - gnuradio.gr.feval - diff --git a/docs/sphinx/source/gr_unittest/index.rst b/docs/sphinx/source/gr_unittest/index.rst deleted file mode 100644 index 2169a7da41..0000000000 --- a/docs/sphinx/source/gr_unittest/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr_unittest -==================== - -.. automodule:: gnuradio.gr_unittest - -.. autoclass:: gnuradio.gr_unittest.TestCase -.. autofunction:: gnuradio.gr_unittest.run diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 3830d58c24..7bba2f8e32 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -1,166 +1,1475 @@ gnuradio ======== +.. toctree:: + :hidden: + + runtime <runtime> + pmt <pmt> + blocks_audio <audio_blocks> + blocks_analog <analog_blocks> + blocks_blocks <blocks_blocks> + blocks_channels <channels_blocks> + blocks_comedi <comedi_blocks> + blocks_digital <digital_blocks> + blocks_dtv <dtv_blocks> + blocks_fcd <fcd_blocks> + blocks_fec <fec_blocks> + blocks_fft <fft_blocks> + blocks_filter <filter_blocks> + blocks_noaa <noaa_blocks> + blocks_pager <pager_blocks> + blocks_qtgui <qtgui_blocks> + blocks_trellis <trellis_blocks> + blocks_uhd <uhd_blocks> + blocks_video_sdl <video_sdl_blocks> + blocks_vocoder <vocoder_blocks> + blocks_wavelet <wavelet_blocks> + blocks_wxgui <wxgui_blocks> + blocks_zeromq <zeromq_blocks> + analog <analog> + channels <channels> + digital <digital> + dtv <dtv> + fec <fec> + fft <fft> + filter <filter> + trellis <trellis> + uhd <uhd> + vocoder <vocoder> + wxgui <wxgui> + .. automodule:: gnuradio +.. automodule:: pmt + +Runtime +------- + +.. autosummary:: + :nosignatures: + + gnuradio.gr.top_block + gnuradio.gr.basic_block + gnuradio.gr.block + gnuradio.gr.sync_block + gnuradio.gr.sync_decimator + gnuradio.gr.sync_interpolator + gnuradio.gr.tagged_stream_block + gnuradio.gr.hier_block2 + gnuradio.gr.high_res_timer_now + gnuradio.gr.high_res_timer_now_perfmon + gnuradio.gr.high_res_timer_epoch + gnuradio.gr.high_res_timer_tps + gnuradio.gr.io_signature + gnuradio.gr.io_signature2 + gnuradio.gr.io_signature3 + gnuradio.gr.io_signaturev + gnuradio.gr.prefix + gnuradio.gr.prefsdir + gnuradio.gr.sysconfdir + gnuradio.gr.version + gnuradio.gr.major_version + gnuradio.gr.api_version + gnuradio.gr.minor_version + gnuradio.gr.prefs + gnuradio.gr.logger + gnuradio.gr.logger_config + gnuradio.gr.logger_get_names + gnuradio.gr.logger_reset_config + gnuradio.gr.tag_t + gnuradio.gr.tag_t_offset_compare + gnuradio.gr.tag_t_offset_compare_key + gnuradio.gr.tag_to_pmt + gnuradio.gr.tag_to_python + gnuradio.gr.tag_utils + gnuradio.gr.sizeof_gr_complex + gnuradio.gr.sizeof_float + gnuradio.gr.sizeof_int + gnuradio.gr.sizeof_short + gnuradio.gr.sizeof_char + gnuradio.gr.sizeof_double + gnuradio.gr.branchless_binary_slicer + gnuradio.gr.binary_slicer + gnuradio.gr.branchless_clip + gnuradio.gr.clip + gnuradio.gr.branchless_quad_0deg_slicer + gnuradio.gr.quad_0deg_slicer + gnuradio.gr.branchless_quad_45deg_slicer + gnuradio.gr.quad_45deg_slicer + gnuradio.gr.feval + gnuradio.gr.feval_cc + gnuradio.gr.feval_dd + gnuradio.gr.feval_ll + gnuradio.gr.feval_p + gnuradio.gr.gateway + -Core Framework +PMT +--- + +.. autosummary:: + :nosignatures: + + pmt.acons + pmt.any_ref + pmt.any_set + pmt.assoc + pmt.assq + pmt.assv + pmt.blob_data + pmt.blob_length + pmt.c32vector_elements + pmt.c32vector_ref + pmt.c32vector_set + pmt.c64vector_elements + pmt.c64vector_ref + pmt.c64vector_set + pmt.caar + pmt.cadddr + pmt.caddr + pmt.cadr + pmt.car + pmt.cdar + pmt.cddr + pmt.cdr + pmt.cons + pmt.deserialize + pmt.deserialize_str + pmt.dict_add + pmt.dict_delete + pmt.dict_has_key + pmt.dict_items + pmt.dict_keys + pmt.dict_ref + pmt.dict_update + pmt.dict_values + pmt.dump_sizeof + pmt.eq + pmt.equal + pmt.eqv + pmt.f32vector_elements + pmt.f32vector_ref + pmt.f32vector_set + pmt.f64vector_elements + pmt.f64vector_ref + pmt.f64vector_set + pmt.from_bool + pmt.from_complex + pmt.from_double + pmt.from_float + pmt.from_long + pmt.from_uint64 + pmt.get_PMT_EOF + pmt.get_PMT_F + pmt.get_PMT_NIL + pmt.get_PMT_T + pmt.init_c32vector + pmt.init_c64vector + pmt.init_f32vector + pmt.init_f64vector + pmt.init_s16vector + pmt.init_s32vector + pmt.init_s8vector + pmt.init_u16vector + pmt.init_u32vector + pmt.init_u8vector + pmt.intern + pmt.is_any + pmt.is_blob + pmt.is_bool + pmt.is_c32vector + pmt.is_c64vector + pmt.is_complex + pmt.is_dict + pmt.is_eof_object + pmt.is_f32vector + pmt.is_f64vector + pmt.is_false + pmt.is_integer + pmt.is_msg_accepter + pmt.is_null + pmt.is_number + pmt.is_pair + pmt.is_real + pmt.is_s16vector + pmt.is_s32vector + pmt.is_s64vector + pmt.is_s8vector + pmt.is_symbol + pmt.is_true + pmt.is_tuple + pmt.is_u16vector + pmt.is_u32vector + pmt.is_u64vector + pmt.is_u8vector + pmt.is_uint64 + pmt.is_uniform_vector + pmt.is_vector + pmt.length + pmt.list1 + pmt.list2 + pmt.list3 + pmt.list4 + pmt.list5 + pmt.list6 + pmt.list_add + pmt.list_has + pmt.list_rm + pmt.make_any + pmt.make_blob + pmt.make_c32vector + pmt.make_c64vector + pmt.make_dict + pmt.make_f32vector + pmt.make_f64vector + pmt.make_msg_accepter + pmt.make_rectangular + pmt.make_s16vector + pmt.make_s32vector + pmt.make_s64vector + pmt.make_s8vector + pmt.make_tuple + pmt.make_u16vector + pmt.make_u32vector + pmt.make_u64vector + pmt.make_u8vector + pmt.make_vector + pmt.map + pmt.member + pmt.memq + pmt.memv + pmt.msg_accepter_ref + pmt.nth + pmt.nthcdr + pmt.pmt_vector_cdouble + pmt.pmt_vector_cfloat + pmt.pmt_vector_double + pmt.pmt_vector_float + pmt.pmt_vector_int16 + pmt.pmt_vector_int32 + pmt.pmt_vector_int8 + pmt.pmt_vector_uint16 + pmt.pmt_vector_uint32 + pmt.pmt_vector_uint8 + pmt.read + pmt.reverse + pmt.reverse_x + pmt.s16vector_elements + pmt.s16vector_ref + pmt.s16vector_set + pmt.s32vector_elements + pmt.s32vector_ref + pmt.s32vector_set + pmt.s64vector_ref + pmt.s64vector_set + pmt.s8vector_elements + pmt.s8vector_ref + pmt.s8vector_set + pmt.serialize + pmt.serialize_str + pmt.set_car + pmt.set_cdr + pmt.string_to_symbol + pmt.subsetp + pmt.symbol_to_string + pmt.to_bool + pmt.to_complex + pmt.to_double + pmt.to_float + pmt.to_long + pmt.to_pmt + pmt.to_python + pmt.to_tuple + pmt.to_uint64 + pmt.tuple_ref + pmt.u16vector_elements + pmt.u16vector_ref + pmt.u16vector_set + pmt.u32vector_elements + pmt.u32vector_ref + pmt.u32vector_set + pmt.u64vector_ref + pmt.u64vector_set + pmt.u8vector_elements + pmt.u8vector_ref + pmt.u8vector_set + pmt.uniform_vector_elements + pmt.uniform_vector_itemsize + pmt.vector_fill + pmt.vector_ref + pmt.vector_set + pmt.write + pmt.write_string + + +Audio Signals +------------- + +.. autosummary:: + :nosignatures: + + gnuradio.audio.sink + gnuradio.audio.source + gnuradio.vocoder.alaw_decode_bs + gnuradio.vocoder.alaw_encode_sb + gnuradio.vocoder.codec2_decode_ps + gnuradio.vocoder.codec2_encode_sp + gnuradio.vocoder.cvsd_decode_bs + gnuradio.vocoder.cvsd_encode_sb + gnuradio.vocoder.g721_decode_bs + gnuradio.vocoder.g721_encode_sb + gnuradio.vocoder.g723_24_decode_bs + gnuradio.vocoder.g723_24_encode_sb + gnuradio.vocoder.g723_40_decode_bs + gnuradio.vocoder.g723_40_encode_sb + gnuradio.vocoder.gsm_fr_decode_ps + gnuradio.vocoder.gsm_fr_encode_sp + gnuradio.vocoder.ulaw_decode_bs + gnuradio.vocoder.ulaw_encode_sb + gnuradio.blocks.wavfile_sink + gnuradio.blocks.wavfile_source + +Boolean Operators +----------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.and_bb + gnuradio.blocks.and_const_bb + gnuradio.blocks.and_const_ii + gnuradio.blocks.and_const_ss + gnuradio.blocks.and_ii + gnuradio.blocks.and_ss + gnuradio.blocks.not_bb + gnuradio.blocks.not_ii + gnuradio.blocks.not_ss + gnuradio.blocks.or_bb + gnuradio.blocks.or_ii + gnuradio.blocks.or_ss + gnuradio.blocks.xor_bb + gnuradio.blocks.xor_ii + gnuradio.blocks.xor_ss + +Byte Operators -------------- .. autosummary:: :nosignatures: - gnuradio.gr - pmt - gnuradio.blocks - gnuradio.analog - gnuradio.digital - gnuradio.audio - gnuradio.channels - gnuradio.comedi - gnuradio.fec - gnuradio.filter - gnuradio.trellis - gnuradio.wavelet - gnuradio.fft - gnuradio.gr_unittest - gnuradio.qtgui - gnuradio.wxgui + gnuradio.blocks.packed_to_unpacked_bb + gnuradio.blocks.packed_to_unpacked_ii + gnuradio.blocks.packed_to_unpacked_ss + gnuradio.blocks.unpacked_to_packed_bb + gnuradio.blocks.unpacked_to_packed_ii + gnuradio.blocks.unpacked_to_packed_ss + gnuradio.blocks.pack_k_bits_bb + gnuradio.blocks.repack_bits_bb + gnuradio.blocks.unpack_k_bits_bb -.. toctree:: - :hidden: +Channelizers +------------ + +.. autosummary:: + :nosignatures: + + gnuradio.filter.freq_xlating_fir_filter_ccc + gnuradio.filter.freq_xlating_fir_filter_ccf + gnuradio.filter.freq_xlating_fir_filter_fcc + gnuradio.filter.freq_xlating_fir_filter_fcf + gnuradio.filter.freq_xlating_fir_filter_scc + gnuradio.filter.freq_xlating_fir_filter_scf + gnuradio.filter.pfb_channelizer_ccf + gnuradio.filter.pfb_decimator_ccf + gnuradio.filter.pfb_interpolator_ccf + gnuradio.filter.pfb_synthesizer_ccf + +Channel Models +-------------- + +.. autosummary:: + :nosignatures: - gnuradio.gr <gr/index> - pmt <pmt/index> - gnuradio.blocks <blocks/index> - gnuradio.analog <analog/index> - gnuradio.digital <digital/index> - gnuradio.audio <audio/index> - gnuradio.channels <channels> - gnuradio.comedi <comedi> - gnuradio.fec <fec> - gnuradio.filter <filter/index> - gnuradio.gr_unittest <gr_unittest/index> - gnuradio.trellis <trellis/index> - gnuradio.wavelet <wavelet> - gnuradio.fft <fft> - gnuradio.qtgui <qtgui/index> - gnuradio.wxgui <wxgui/index> - -Hardware Interfaces + gnuradio.channels.channel_model + gnuradio.channels.channel_model2 + gnuradio.channels.fading_model + gnuradio.channels.selective_fading_model + gnuradio.channels.dynamic_channel_model + gnuradio.channels.cfo_model + gnuradio.channels.sro_model + + +Coding Blocks +------------- + +.. autosummary:: + :nosignatures: + + gnuradio.digital.additive_scrambler_bb + gnuradio.digital.descrambler_bb + gnuradio.digital.scrambler_bb + + +ControlPort Blocks +------------------ + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.ctrlport_probe2_b + gnuradio.blocks.ctrlport_probe2_c + gnuradio.blocks.ctrlport_probe2_f + gnuradio.blocks.ctrlport_probe2_i + gnuradio.blocks.ctrlport_probe2_s + gnuradio.blocks.ctrlport_probe_c + gnuradio.fft.ctrlport_probe_psd + + +Debug Blocks +------------ + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.message_debug + gnuradio.blocks.message_strobe + gnuradio.blocks.message_strobe_random + gnuradio.blocks.tag_debug + gnuradio.blocks.tags_strobe + gnuradio.blocks.vector_sink_b + gnuradio.blocks.vector_sink_c + gnuradio.blocks.vector_sink_f + gnuradio.blocks.vector_sink_i + gnuradio.blocks.vector_sink_s + gnuradio.blocks.random_pdu + + +DTV Blocks +------------ + +.. autosummary:: + :nosignatures: + + gnuradio.dtv.atsc_deinterleaver + gnuradio.dtv.atsc_depad + gnuradio.dtv.atsc_derandomizer + gnuradio.dtv.atsc_equalizer + gnuradio.dtv.atsc_field_sync_mux + gnuradio.dtv.atsc_fpll + gnuradio.dtv.atsc_fs_checker + gnuradio.dtv.atsc_interleaver + gnuradio.dtv.atsc_pad + gnuradio.dtv.atsc_randomizer + gnuradio.dtv.atsc_rs_decoder + gnuradio.dtv.atsc_rs_encoder + gnuradio.dtv.atsc_sync + gnuradio.dtv.atsc_trellis_encoder + gnuradio.dtv.atsc_viterbi_decoder + gnuradio.dtv.dvb_bbheader_bb + gnuradio.dtv.dvb_bbscrambler_bb + gnuradio.dtv.dvb_bch_bb + gnuradio.dtv.dvb_ldpc_bb + gnuradio.dtv.dvbs2_interleaver_bb + gnuradio.dtv.dvbs2_modulator_bc + gnuradio.dtv.dvbs2_physical_cc + gnuradio.dtv.dvbt2_cellinterleaver_cc + gnuradio.dtv.dvbt2_framemapper_cc + gnuradio.dtv.dvbt2_freqinterleaver_cc + gnuradio.dtv.dvbt2_interleaver_bb + gnuradio.dtv.dvbt2_miso_cc + gnuradio.dtv.dvbt2_modulator_bc + gnuradio.dtv.dvbt2_p1insertion_cc + gnuradio.dtv.dvbt2_paprtr_cc + gnuradio.dtv.dvbt2_pilotgenerator_cc + gnuradio.dtv.dvbt_bit_inner_interleaver + gnuradio.dtv.dvbt_convolutional_interleaver + gnuradio.dtv.dvbt_energy_dispersal + gnuradio.dtv.dvbt_inner_coder + gnuradio.dtv.dvbt_map + gnuradio.dtv.dvbt_reed_solomon_enc + gnuradio.dtv.dvbt_reference_signals + gnuradio.dtv.dvbt_symbol_inner_interleaver + + +Equalizer Blocks +---------------- + +.. autosummary:: + :nosignatures: + + gnuradio.digital.cma_equalizer_cc + gnuradio.digital.lms_dd_equalizer_cc + gnuradio.digital.kurtotic_equalizer_cc + +Error Coding Blocks ------------------- .. autosummary:: :nosignatures: - gnuradio.uhd - gnuradio.fcd + gnuradio.fec.async_decoder + gnuradio.fec.async_encoder + gnuradio.fec.ber_bf + gnuradio.fec.conv_bit_corr_bb + gnuradio.fec.decode_ccsds_27_fb + gnuradio.fec.decoder + gnuradio.fec.depuncture_bb + gnuradio.fec.encode_ccsds_27_bb + gnuradio.fec.encoder + gnuradio.fec.generic_decoder + gnuradio.fec.generic_encoder + gnuradio.fec.puncture_bb + gnuradio.fec.puncture_ff + gnuradio.fec.tagged_decoder + gnuradio.fec.tagged_encoder -.. toctree:: - :hidden: - gnuradio.uhd <uhd> - gnuradio.fcd <fcd> +FCD Blocks +---------- + +.. autosummary:: + :nosignatures: + + gnuradio.fcd.source_c + -Utilities ---------- +File Operator Blocks +-------------------- .. autosummary:: :nosignatures: - gnuradio.plot_data - gnuradio.eng_notation - gnuradio.eng_option + gnuradio.blocks.file_descriptor_sink + gnuradio.blocks.file_descriptor_source + gnuradio.blocks.file_meta_sink + gnuradio.blocks.file_meta_source + gnuradio.blocks.file_sink + gnuradio.blocks.file_source + gnuradio.blocks.tagged_file_sink -.. toctree:: - :hidden: - gnuradio.plot_data <plot_data> - gnuradio.eng_notation <eng_notation/index> - gnuradio.eng_option <eng_option/index> +Filter Blocks +------------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.dc_blocker_cc + gnuradio.filter.dc_blocker_ff + gnuradio.filter.fft_filter_ccc + gnuradio.filter.fft_filter_ccf + gnuradio.filter.fft_filter_fff + gnuradio.filter.filter_delay_fc + gnuradio.filter.filterbank_vcvcf + gnuradio.filter.fir_filter_ccc + gnuradio.filter.fir_filter_ccf + gnuradio.filter.fir_filter_fcc + gnuradio.filter.fir_filter_fff + gnuradio.filter.fir_filter_fsf + gnuradio.filter.fir_filter_scc + gnuradio.filter.fractional_interpolator_cc + gnuradio.filter.fractional_interpolator_ff + gnuradio.filter.fractional_resampler_cc + gnuradio.filter.fractional_resampler_ff + gnuradio.filter.freq_xlating_fir_filter_ccc + gnuradio.filter.freq_xlating_fir_filter_ccf + gnuradio.filter.freq_xlating_fir_filter_fcc + gnuradio.filter.freq_xlating_fir_filter_fcf + gnuradio.filter.freq_xlating_fir_filter_scc + gnuradio.filter.freq_xlating_fir_filter_scf + gnuradio.filter.hilbert_fc + gnuradio.filter.iir_filter_ccc + gnuradio.filter.iir_filter_ccd + gnuradio.filter.iir_filter_ccf + gnuradio.filter.iir_filter_ccz + gnuradio.filter.iir_filter_ffd + gnuradio.filter.interp_fir_filter_ccc + gnuradio.filter.interp_fir_filter_ccf + gnuradio.filter.interp_fir_filter_fcc + gnuradio.filter.interp_fir_filter_fff + gnuradio.filter.interp_fir_filter_fsf + gnuradio.filter.interp_fir_filter_scc + gnuradio.filter.pfb_arb_resampler_ccc + gnuradio.filter.pfb_arb_resampler_ccf + gnuradio.filter.pfb_arb_resampler_fff + gnuradio.filter.pfb_channelizer_ccf + gnuradio.filter.pfb_decimator_ccf + gnuradio.filter.pfb_interpolator_ccf + gnuradio.filter.pfb_synthesizer_ccf + gnuradio.filter.rational_resampler_base_ccc + gnuradio.filter.rational_resampler_base_ccf + gnuradio.filter.rational_resampler_base_fcc + gnuradio.filter.rational_resampler_base_fff + gnuradio.filter.rational_resampler_base_fsf + gnuradio.filter.rational_resampler_base_scc + gnuradio.filter.single_pole_iir_filter_cc + gnuradio.filter.single_pole_iir_filter_ff + -Framework Extensions + +Fourier Analysis +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.fft.fft_vcc + gnuradio.fft.fft_vfc + gnuradio.fft.goertzel_fc + + +Impairment Model Blocks +----------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.channels.amp_bal + gnuradio.channels.conj_fs_iqcorr + gnuradio.channels.distortion_2_gen + gnuradio.channels.distortion_3_gen + gnuradio.channels.impairments + gnuradio.channels.iqbal_gen + gnuradio.channels.phase_bal + gnuradio.channels.phase_noise_gen + gnuradio.channels.quantizer + + +Instrumentation Blocks +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.qtgui.ber_sink_b + gnuradio.qtgui.const_sink_c + gnuradio.qtgui.freq_sink_c + gnuradio.qtgui.freq_sink_f + gnuradio.qtgui.histogram_sink_f + gnuradio.qtgui.number_sink + gnuradio.qtgui.sink_c + gnuradio.qtgui.sink_f + gnuradio.qtgui.time_raster_sink_b + gnuradio.qtgui.time_raster_sink_f + gnuradio.qtgui.time_sink_c + gnuradio.qtgui.time_sink_f + gnuradio.qtgui.vector_sink_f + gnuradio.qtgui.waterfall_sink_c + gnuradio.qtgui.waterfall_sink_f + gnuradio.wxgui.histo_sink_f + gnuradio.wxgui.oscope_sink_f + + + +Level Control Blocks -------------------- .. autosummary:: :nosignatures: - gnuradio.atsc - gnuradio.noaa - gnuradio.pager - gnuradio.video_sdl - gnuradio.vocoder + gnuradio.analog.agc2_cc + gnuradio.analog.agc2_ff + gnuradio.analog.agc3_cc + gnuradio.analog.agc_cc + gnuradio.analog.agc_ff + gnuradio.analog.ctcss_squelch_ff + gnuradio.analog.feedforward_agc_cc + gnuradio.blocks.moving_average_cc + gnuradio.blocks.moving_average_ff + gnuradio.blocks.moving_average_ii + gnuradio.blocks.moving_average_ss + gnuradio.blocks.mute_cc + gnuradio.blocks.mute_ff + gnuradio.blocks.mute_ii + gnuradio.blocks.mute_ss + gnuradio.analog.pwr_squelch_cc + gnuradio.analog.pwr_squelch_ff + gnuradio.analog.rail_ff + gnuradio.blocks.sample_and_hold_bb + gnuradio.blocks.sample_and_hold_ff + gnuradio.blocks.sample_and_hold_ii + gnuradio.blocks.sample_and_hold_ss + gnuradio.analog.simple_squelch_cc + gnuradio.blocks.threshold_ff -.. toctree:: - :hidden: - gnuradio.atsc <atsc/index> - gnuradio.noaa <noaa> - gnuradio.pager <pager/index> - gnuradio.video_sdl <video_sdl> - gnuradio.vocoder <vocoder/index> +Math Operator Blocks +-------------------- +.. autosummary:: + :nosignatures: -.. Use this to add to the toctree but not displayed -.. It's mostly to get rid of warnings + gnuradio.blocks.abs_ff + gnuradio.blocks.abs_ii + gnuradio.blocks.abs_ss + gnuradio.blocks.add_cc + gnuradio.blocks.add_ff + gnuradio.blocks.add_ii + gnuradio.blocks.add_ss + gnuradio.blocks.add_const_bb + gnuradio.blocks.add_const_cc + gnuradio.blocks.add_const_ff + gnuradio.blocks.add_const_ii + gnuradio.blocks.add_const_ss + gnuradio.blocks.add_const_vbb + gnuradio.blocks.add_const_vcc + gnuradio.blocks.add_const_vff + gnuradio.blocks.add_const_vii + gnuradio.blocks.add_const_vss + gnuradio.blocks.argmax_fs + gnuradio.blocks.argmax_is + gnuradio.blocks.argmax_ss + gnuradio.blocks.conjugate_cc + gnuradio.blocks.divide_cc + gnuradio.blocks.divide_ff + gnuradio.blocks.divide_ii + gnuradio.blocks.divide_ss + gnuradio.blocks.integrate_cc + gnuradio.blocks.integrate_ff + gnuradio.blocks.integrate_ii + gnuradio.blocks.integrate_ss + gnuradio.blocks.nlog10_ff + gnuradio.blocks.max_ff + gnuradio.blocks.max_ii + gnuradio.blocks.max_ss + gnuradio.blocks.min_ff + gnuradio.blocks.min_ii + gnuradio.blocks.min_ss + gnuradio.blocks.multiply_cc + gnuradio.blocks.multiply_ff + gnuradio.blocks.multiply_ii + gnuradio.blocks.multiply_ss + gnuradio.blocks.multiply_matrix_ff + gnuradio.blocks.multiply_conjugate_cc + gnuradio.blocks.multiply_const_cc + gnuradio.blocks.multiply_const_ff + gnuradio.blocks.multiply_const_ii + gnuradio.blocks.multiply_const_ss + gnuradio.blocks.multiply_const_vcc + gnuradio.blocks.multiply_const_vff + gnuradio.blocks.multiply_const_vii + gnuradio.blocks.multiply_const_vss + gnuradio.blocks.rms_cf + gnuradio.blocks.rms_ff + gnuradio.blocks.rotator_cc + gnuradio.blocks.sub_cc + gnuradio.blocks.sub_ff + gnuradio.blocks.sub_ii + gnuradio.blocks.sub_ss + gnuradio.blocks.transcendental -.. toctree:: - :hidden: - runtime_contents <gr/contents> - atsc_blks <atsc/blks> - digital_blocks <digital/blocks> - constellations <digital/constellations> - ofdm <digital/ofdm> - pkt_utils <digital/pkt_utils> - digital_utilities <digital/utilities> - pager_blks <pager/blks> - pyqt_filter <pyqt_filter> - pyqt_plot <pyqt_plot> - trellis_blks <trellis/blks> - trellis_objs <trellis/objs> - vocoder_blks <vocoder/blks> - wxgui_blks <wxgui/blks> - blocks_modulators <blocks/modulators_blk> - blocks_audio <blocks/audio_blk> - blocks_networking <blocks/networking_tools_blk> - blocks_boolean <blocks/boolean_operators_blk> - blocks_peak_detectors <blocks/peak_detectors_blk> - blocks_byte_operators <blocks/byte_operators_blk> - blocks_level_controllers <blocks/level_controllers_blk> - blocks_stream_operators <blocks/stream_operators_blk> - blocks_controlport <blocks/controlport_blk> - blocks_math <blocks/math_operators_blk> - blocks_stream_tag <blocks/stream_tag_tools_blk> - blocks_debug <blocks/debug_tools_blk> - blocks_measurement <blocks/measurement_tools_blk> - blocks_type_converters <blocks/type_converters_blk> - blocks_file <blocks/file_operators_blk> - blocks_message <blocks/message_tools_blk> - blocks_waveform <blocks/waveform_generators_blk> - blocks_misc <blocks/misc_blk> - analog_level_controllers <analog/level_controllers_blk> - analog_peak_detectors <analog/peak_detectors_blk> - analog_measurement <analog/measurement_tools_blk> - analog_synchronizers <analog/synchronizers_blk> - analog_modulators <analog/modulators_blk> - filter_channelizers <filter/channelizers_blk> - filter_resamplers <filter/resamplers_blk> - filter_blocks <filter/filter_blk> - filter_design <filter/filter_design> - pmt_any <pmt/any> - pmt_generalfunctions <pmt/generalfunctions> - pmt_message_accepter <pmt/message_accepter> - pmt_readwrite <pmt/readwrite> - pmt_tuple <pmt/tuple> - pmt_boolean <pmt/boolean> - pmt_misc <pmt/misc> - pmt_real <pmt/real> - pmt_vector <pmt/vector> - pmt_integer <pmt/integer> - pmt_number <pmt/number> - pmt_serialize <pmt/serialize> - pmt_dictionary <pmt/dictionary> - pmt_list <pmt/list> - pmt_pair <pmt/pair> - pmt_symbol <pmt/symbol> +Measurement Tool Blocks +----------------------_ + +.. autosummary:: + :nosignatures: + + gnuradio.digital.mpsk_snr_est_cc + gnuradio.digital.probe_mpsk_snr_est_c + gnuradio.digital.probe_density_b + gnuradio.blocks.probe_rate + gnuradio.blocks.probe_signal_b + gnuradio.blocks.probe_signal_c + gnuradio.blocks.probe_signal_f + gnuradio.blocks.probe_signal_i + gnuradio.blocks.probe_signal_s + gnuradio.blocks.probe_signal_vb + gnuradio.blocks.probe_signal_vc + gnuradio.blocks.probe_signal_vf + gnuradio.blocks.probe_signal_vi + gnuradio.blocks.probe_signal_vs + + +Message Tool Blocks +------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.message_burst_source + gnuradio.blocks.message_debug + gnuradio.blocks.message_sink + gnuradio.blocks.message_source + gnuradio.blocks.message_strobe + gnuradio.blocks.message_strobe_random + gnuradio.blocks.pdu_filter + gnuradio.blocks.pdu_remove + gnuradio.blocks.pdu_set + gnuradio.blocks.pdu_to_tagged_stream + gnuradio.blocks.tagged_stream_multiply_length + gnuradio.blocks.tagged_stream_to_pdu + + +Misc Blocks +----------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.copy + gnuradio.blocks.delay + gnuradio.blocks.head + gnuradio.blocks.nop + gnuradio.blocks.null_sink + gnuradio.blocks.null_source + gnuradio.blocks.skiphead + gnuradio.blocks.throttle + gnuradio.blocks.vector_source_b + gnuradio.blocks.vector_source_c + gnuradio.blocks.vector_source_f + gnuradio.blocks.vector_source_i + gnuradio.blocks.vector_source_s + + +Modulator Blocks +---------------- + +.. autosummary:: + :nosignatures: + + gnuradio.analog.am_demod_cf + gnuradio.analog.cpm + gnuradio.analog.cpfsk_bc + gnuradio.analog.frequency_modulator_fc + gnuradio.analog.fm_demod_cf + gnuradio.analog.demod_20k0f3e_cf + gnuradio.analog.demod_200kf3e_cf + gnuradio.analog.fm_deemph + gnuradio.analog.fm_preemph + gnuradio.analog.nbfm_rx + gnuradio.analog.nbfm_tx + gnuradio.analog.phase_modulator_fc + gnuradio.analog.quadrature_demod_cf + gnuradio.analog.wfm_rcv_fmdet + gnuradio.analog.wfm_rcv_pll + gnuradio.analog.wfm_rcv + gnuradio.analog.wfm_tx + + +Networking Tools Blocks +----------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.socket_pdu + gnuradio.blocks.udp_sink + gnuradio.blocks.udp_source + + +NOAA Blocks +----------- + +.. autosummary:: + :nosignatures: + + gnuradio.noaa.hrpt_decoder + gnuradio.noaa.hrpt_deframer + gnuradio.noaa.hrpt_pll_cf + + +OFDM Blocks +----------- + +.. autosummary:: + :nosignatures: + + gnuradio.digital.ofdm_carrier_allocator_cvc + gnuradio.digital.ofdm_chanest_vcvc + gnuradio.digital.ofdm_cyclic_prefixer + gnuradio.digital.ofdm_equalizer_base + gnuradio.digital.ofdm_equalizer_simpledfe + gnuradio.digital.ofdm_equalizer_static + gnuradio.digital.ofdm_frame_acquisition + gnuradio.digital.ofdm_frame_equalizer_vcvc + gnuradio.digital.ofdm_frame_sink + gnuradio.digital.ofdm_insert_preamble + gnuradio.digital.ofdm_sampler + gnuradio.digital.ofdm_serializer_vcc + gnuradio.digital.ofdm_sync_sc_cfb + + +Packet Operator Blocks +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.digital.crc32_async_bb + gnuradio.digital.crc32_bb + gnuradio.digital.correlate_access_code_bb + gnuradio.digital.correlate_access_code_bb_ts + gnuradio.digital.correlate_access_code_ff_ts + gnuradio.digital.correlate_access_code_tag_bb + gnuradio.digital.framer_sink_1 + gnuradio.digital.hdlc_deframer_bp + gnuradio.digital.hdlc_framer_pb + gnuradio.digital.header_payload_demux + gnuradio.digital.packet_header_default + gnuradio.digital.packet_headergenerator_bb + gnuradio.digital.packet_sink + gnuradio.digital.simple_correlator + gnuradio.digital.simple_framer + + +Pager Blocks +------------ + +.. autosummary:: + :nosignatures: + + gnuradio.pager.flex_deinterleave + gnuradio.pager.flex_frame + gnuradio.pager.flex_parse + gnuradio.pager.flex_sync + gnuradio.pager.slicer_fb + + +Peak Detector Blocks +-------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.burst_tagger + gnuradio.blocks.peak_detector2_fb + gnuradio.blocks.peak_detector_fb + gnuradio.blocks.peak_detector_ib + gnuradio.blocks.peak_detector_sb + gnuradio.blocks.plateau_detector_fb + + +Resampler Blocks +---------------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.fractional_resampler_cc + gnuradio.filter.fractional_resampler_ff + gnuradio.filter.pfb.arb_resampler_ccf + gnuradio.filter.pfb.arb_resampler_fff + gnuradio.filter.pfb.arb_resampler_ccc + gnuradio.filter.pfb_arb_resampler_ccc + gnuradio.filter.pfb_arb_resampler_ccf + gnuradio.filter.pfb_arb_resampler_fff + gnuradio.filter.rational_resampler_fff + gnuradio.filter.rational_resampler_ccf + gnuradio.filter.rational_resampler_ccc + gnuradio.filter.rational_resampler_base_ccc + gnuradio.filter.rational_resampler_base_ccf + gnuradio.filter.rational_resampler_base_fcc + gnuradio.filter.rational_resampler_base_fff + gnuradio.filter.rational_resampler_base_fsf + gnuradio.filter.rational_resampler_base_scc + + +Stream Operator Blocks +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.deinterleave + gnuradio.blocks.endian_swap + gnuradio.blocks.keep_m_in_n + gnuradio.blocks.keep_one_in_n + gnuradio.blocks.patterned_interleaver + gnuradio.blocks.regenerate_bb + gnuradio.blocks.repeat + gnuradio.blocks.stream_mux + gnuradio.blocks.stream_to_streams + gnuradio.blocks.stream_to_tagged_stream + gnuradio.blocks.stream_to_vector + gnuradio.blocks.streams_to_stream + gnuradio.blocks.streams_to_vector + gnuradio.blocks.stretch_ff + gnuradio.blocks.tagged_stream_mux + gnuradio.blocks.vector_insert_b + gnuradio.blocks.vector_insert_c + gnuradio.blocks.vector_insert_f + gnuradio.blocks.vector_insert_i + gnuradio.blocks.vector_insert_s + gnuradio.blocks.vector_to_stream + gnuradio.blocks.vector_to_streams + + +Stream Tag Tool Blocks +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.stream_to_tagged_stream + gnuradio.blocks.tag_gate + gnuradio.blocks.tagged_stream_align + gnuradio.blocks.tagged_stream_multiply_length + gnuradio.blocks.tagged_stream_mux + + +Symbol Coding Blocks +-------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.digital.binary_slicer_fb + gnuradio.digital.chunks_to_symbols_bc + gnuradio.digital.chunks_to_symbols_bf + gnuradio.digital.chunks_to_symbols_ic + gnuradio.digital.chunks_to_symbols_if + gnuradio.digital.chunks_to_symbols_sc + gnuradio.digital.chunks_to_symbols_sf + gnuradio.digital.constellation_decoder_cb + gnuradio.digital.constellation_soft_decoder_cf + gnuradio.digital.diff_decoder_bb + gnuradio.digital.diff_encoder_bb + gnuradio.digital.diff_phasor_cc + gnuradio.digital.map_bb + + +Synchronizer Blocks +-------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.digital.clock_recovery_mm_cc + gnuradio.digital.clock_recovery_mm_ff + gnuradio.digital.correlate_and_sync_cc + gnuradio.digital.corr_est_cc + gnuradio.digital.costas_loop_cc + gnuradio.digital.fll_band_edge_cc + gnuradio.digital.mpsk_receiver_cc + gnuradio.digital.msk_timing_recovery_cc + gnuradio.analog.pll_carriertracking_cc + gnuradio.analog.pll_freqdet_cf + gnuradio.analog.pll_refout_cc + gnuradio.digital.pn_correlator_cc + gnuradio.digital.pfb_clock_sync_ccf + gnuradio.digital.pfb_clock_sync_fff + + +Trellis Coding 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 + + + +Type Converter Blocks +--------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.char_to_float + gnuradio.blocks.char_to_short + gnuradio.blocks.complex_to_arg + gnuradio.blocks.complex_to_float + gnuradio.blocks.complex_to_imag + gnuradio.blocks.complex_to_interleaved_short + gnuradio.blocks.complex_to_mag + gnuradio.blocks.complex_to_mag_squared + gnuradio.blocks.complex_to_real + gnuradio.blocks.float_to_char + gnuradio.blocks.float_to_complex + gnuradio.blocks.float_to_int + gnuradio.blocks.float_to_short + gnuradio.blocks.float_to_uchar + gnuradio.blocks.int_to_float + gnuradio.blocks.interleaved_char_to_complex + gnuradio.blocks.interleaved_short_to_complex + gnuradio.blocks.short_to_char + gnuradio.blocks.short_to_float + gnuradio.blocks.uchar_to_float + + + +UHD Blocks +---------- + +.. autosummary:: + :nosignatures: + + gnuradio.uhd.amsg_source + gnuradio.uhd.usrp_sink + gnuradio.uhd.usrp_source + + +Video Blocks +------------ + +.. autosummary:: + :nosignatures: + + gnuradio.video_sdl.sink_s + gnuradio.video_sdl.sink_uc + + + +Waveform Generator Blocks +------------------------- + + gnuradio.analog.fastnoise_source_c + gnuradio.analog.fastnoise_source_f + gnuradio.analog.fastnoise_source_i + gnuradio.analog.fastnoise_source_s + gnuradio.analog.noise_source_c + gnuradio.analog.noise_source_f + gnuradio.analog.noise_source_i + gnuradio.analog.noise_source_s + gnuradio.digital.glfsr_source_b + gnuradio.digital.glfsr_source_f + gnuradio.analog.sig_source_c + gnuradio.analog.sig_source_f + gnuradio.analog.sig_source_i + gnuradio.analog.sig_source_s + + +ZeroMQ Interface Blocks +----------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.zeromq.pub_msg_sink + gnuradio.zeromq.pub_sink + gnuradio.zeromq.pull_msg_source + gnuradio.zeromq.pull_source + gnuradio.zeromq.push_msg_sink + gnuradio.zeromq.push_sink + gnuradio.zeromq.rep_msg_sink + gnuradio.zeromq.rep_sink + gnuradio.zeromq.req_msg_source + gnuradio.zeromq.req_source + gnuradio.zeromq.sub_msg_source + gnuradio.zeromq.sub_source + + +Helper Classes: Analog +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.analog.cpm + gnuradio.analog.squelch_base_cc + gnuradio.analog.squelch_base_ff + gnuradio.analog.cpm + gnuradio.analog.squelch_base_cc + gnuradio.analog.squelch_base_ff + gnuradio.analog.am_demod_cf + gnuradio.analog.demod_10k0a3e_cf + gnuradio.analog.fm_demod_cf + gnuradio.analog.demod_20k0f3e_cf + gnuradio.analog.demod_200kf3e_cf + gnuradio.analog.fm_deemph + gnuradio.analog.fm_preemph + gnuradio.analog.nbfm_rx + gnuradio.analog.nbfm_tx + gnuradio.analog.ctcss_gen_f + gnuradio.analog.standard_squelch + gnuradio.analog.wfm_rcv_fmdet + gnuradio.analog.wfm_rcv_pll + gnuradio.analog.wfm_rcv + gnuradio.analog.wfm_tx + + +Helper Classes: Digital +----------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.digital.constellation + gnuradio.digital.lfsr + gnuradio.digital.mpsk_snr_est + gnuradio.digital.simple_framer + gnuradio.digital.crc32 + gnuradio.digital.update_crc32 + gnuradio.digital.bpsk_mod + gnuradio.digital.bpsk_demod + gnuradio.digital.dbpsk_mod + gnuradio.digital.dbpsk_demod + gnuradio.digital.constellation_map_generator + gnuradio.digital.cpm_mod + gnuradio.digital.gen_and_append_crc32 + gnuradio.digital.check_crc32 + gnuradio.digital.generic_mod + gnuradio.digital.generic_demod + gnuradio.digital.gfsk_mod + gnuradio.digital.gfsk_demod + gnuradio.digital.gmsk_mod + gnuradio.digital.gmsk_demod + gnuradio.digital.type_1_mods + gnuradio.digital.add_type_1_mod + gnuradio.digital.type_1_demods + gnuradio.digital.add_type_1_demod + gnuradio.digital.type_1_constellations + gnuradio.digital.add_type_1_constellation + gnuradio.digital.extract_kwargs_from_options + gnuradio.digital.extract_kwargs_from_options_for_class + gnuradio.digital.ofdm_packet_utils.conv_packed_binary_string_to_1_0_string + gnuradio.digital.ofdm_packet_utils.conv_1_0_string_to_packed_binary_string + gnuradio.digital.ofdm_packet_utils.is_1_0_string + gnuradio.digital.ofdm_packet_utils.string_to_hex_list + gnuradio.digital.ofdm_packet_utils.whiten + gnuradio.digital.ofdm_packet_utils.dewhiten + gnuradio.digital.ofdm_packet_utils.make_header + gnuradio.digital.ofdm_packet_utils.make_packet + gnuradio.digital.ofdm_packet_utils.unmake_packet + gnuradio.digital.ofdm_mod + gnuradio.digital.ofdm_demod + gnuradio.digital.ofdm_receiver + gnuradio.digital.ofdm_sync_fixed + gnuradio.digital.ofdm_sync_ml + gnuradio.digital.ofdm_sync_pnac + gnuradio.digital.ofdm_sync_pn + gnuradio.digital.ofdm_tx + gnuradio.digital.ofdm_rx + gnuradio.digital.packet_utils.conv_packed_binary_string_to_1_0_string + gnuradio.digital.packet_utils.conv_1_0_string_to_packed_binary_string + gnuradio.digital.packet_utils.is_1_0_string + gnuradio.digital.packet_utils.string_to_hex_list + gnuradio.digital.packet_utils.whiten + gnuradio.digital.packet_utils.dewhiten + gnuradio.digital.packet_utils.make_header + gnuradio.digital.packet_utils.make_packet + gnuradio.digital.packet_utils.unmake_packet + gnuradio.digital.mod_pkts + gnuradio.digital.demod_pkts + gnuradio.digital.psk_2_0x0 + gnuradio.digital.psk_2_0x1 + gnuradio.digital.sd_psk_2_0x0 + gnuradio.digital.sd_psk_2_0x1 + gnuradio.digital.psk_4_0x0_0_1 + gnuradio.digital.psk_4_0x1_0_1 + gnuradio.digital.psk_4_0x2_0_1 + gnuradio.digital.psk_4_0x3_0_1 + gnuradio.digital.psk_4_0x0_1_0 + gnuradio.digital.psk_4_0x1_1_0 + gnuradio.digital.psk_4_0x2_1_0 + gnuradio.digital.psk_4_0x3_1_0 + gnuradio.digital.sd_psk_4_0x0_0_1 + gnuradio.digital.sd_psk_4_0x1_0_1 + gnuradio.digital.sd_psk_4_0x2_0_1 + gnuradio.digital.sd_psk_4_0x3_0_1 + gnuradio.digital.sd_psk_4_0x0_1_0 + gnuradio.digital.sd_psk_4_0x1_1_0 + gnuradio.digital.sd_psk_4_0x2_1_0 + gnuradio.digital.sd_psk_4_0x3_1_0 + gnuradio.digital.psk_constellation + gnuradio.digital.psk_mod + gnuradio.digital.psk_demod + gnuradio.digital.qam_16_0x0_0_1_2_3 + gnuradio.digital.qam_16_0x1_0_1_2_3 + gnuradio.digital.qam_16_0x2_0_1_2_3 + gnuradio.digital.qam_16_0x3_0_1_2_3 + gnuradio.digital.qam_16_0x0_1_0_2_3 + gnuradio.digital.qam_16_0x1_1_0_2_3 + gnuradio.digital.qam_16_0x2_1_0_2_3 + gnuradio.digital.qam_16_0x3_1_0_2_3 + gnuradio.digital.sd_qam_16_0x0_0_1_2_3 + gnuradio.digital.sd_qam_16_0x1_0_1_2_3 + gnuradio.digital.sd_qam_16_0x2_0_1_2_3 + gnuradio.digital.sd_qam_16_0x3_0_1_2_3 + gnuradio.digital.sd_qam_16_0x0_1_0_2_3 + gnuradio.digital.sd_qam_16_0x1_1_0_2_3 + gnuradio.digital.sd_qam_16_0x2_1_0_2_3 + gnuradio.digital.sd_qam_16_0x3_1_0_2_3 + gnuradio.digital.qam32_holeinside_constellation + gnuradio.digital.make_differential_constellation + gnuradio.digital.make_non_differential_constellation + gnuradio.digital.qam_constellation + gnuradio.digital.qam_mod + gnuradio.digital.qam_demod + gnuradio.digital.qpsk_constellation + gnuradio.digital.qpsk_mod + gnuradio.digital.qpsk_demod + gnuradio.digital.dqpsk_constellation + gnuradio.digital.dqpsk_mod + gnuradio.digital.dqpsk_demod + gnuradio.digital.soft_dec_table_generator + gnuradio.digital.soft_dec_table + gnuradio.digital.calc_soft_dec_from_table + gnuradio.digital.calc_soft_dec + gnuradio.digital.show_table + +Helper Classes: FEC +------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.fec.cc_decoder + gnuradio.fec.cc_encoder + gnuradio.fec.ccsds_encoder + gnuradio.fec.dummy_decoder + gnuradio.fec.dummy_encoder + gnuradio.fec.ldpc_decoder + gnuradio.fec.ldpc_encoder + gnuradio.fec.repetition_decoder + gnuradio.fec.repetition_encoder + gnuradio.fec.tpc_decoder + gnuradio.fec.tpc_encoder + gnuradio.fec.bercurve_generator + gnuradio.fec.bitreverse + gnuradio.fec.bitflip + gnuradio.fec.read_bitlist + gnuradio.fec.read_big_bitlist + gnuradio.fec.generate_symmetries + gnuradio.fec.capillary_threaded_decoder + gnuradio.fec.capillary_threaded_encoder + gnuradio.fec.extended_async_encoder + gnuradio.fec.extended_decoder + gnuradio.fec.extended_encoder + gnuradio.fec.extended_tagged_decoder + gnuradio.fec.extended_tagged_encoder + gnuradio.fec.fec_test + gnuradio.fec.threaded_decoder + gnuradio.fec.threaded_encoder + +Helper Classes: FFT +------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.fft.window + + +Helper Classes: Filter +---------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.filter.filterbank.analysis_filterbank + gnuradio.filter.filterbank.synthesis_filterbank + gnuradio.filter.firdes + gnuradio.filter.pm_remez + gnuradio.filter.synthesis_filterbank + gnuradio.filter.analysis_filterbank + gnuradio.filter.freq_xlating_fft_filter_ccc + gnuradio.filter.optfir.low_pass + gnuradio.filter.optfir.band_pass + gnuradio.filter.optfir.complex_band_pass + gnuradio.filter.optfir.band_reject + gnuradio.filter.optfir.stopband_atten_to_dev + gnuradio.filter.optfir.passband_ripple_to_dev + gnuradio.filter.optfir.remezord + gnuradio.filter.optfir.lporder + gnuradio.filter.optfir.bporder + gnuradio.filter.pfb.channelizer_ccf + gnuradio.filter.pfb.interpolator_ccf + gnuradio.filter.pfb.decimator_ccf + gnuradio.filter.pfb.arb_resampler_ccf + gnuradio.filter.pfb.arb_resampler_fff + gnuradio.filter.pfb.arb_resampler_ccc + gnuradio.filter.pfb.channelizer_hier_ccf + gnuradio.filter.rational_resampler_fff + gnuradio.filter.rational_resampler_ccf + gnuradio.filter.rational_resampler_ccc + + +Helper Classes: Trellis +----------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.trellis.fsm + gnuradio.trellis.interleaver + + +Helper Classes: UHD +------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.uhd.usrp_block + + +Helper Classes: Vocoder +----------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.vocoder.codec2 + gnuradio.vocoder.cvsd_encode_fb + gnuradio.vocoder.cvsd_decode_bf + + +Helper Classes: WXGUI +--------------------- + +.. autosummary:: + :nosignatures: + gnuradio.wxgui.oscope_sink_x + gnuradio.wxgui.histo_sink_f diff --git a/docs/sphinx/source/noaa.rst b/docs/sphinx/source/noaa_blocks.rst index 06c7078130..711ce42785 100644 --- a/docs/sphinx/source/noaa.rst +++ b/docs/sphinx/source/noaa_blocks.rst @@ -1,5 +1,5 @@ gnuradio.noaa -============== +============= .. automodule:: gnuradio.noaa diff --git a/docs/sphinx/source/pager/index.rst b/docs/sphinx/source/pager/index.rst deleted file mode 100644 index 36df48451d..0000000000 --- a/docs/sphinx/source/pager/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -gnuradio.pager -============== - -.. automodule:: gnuradio.pager - -Signal Processing Blocks ------------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.pager.flex_deinterleave - gnuradio.pager.flex_demod - gnuradio.pager.flex_frame - gnuradio.pager.flex_parse - gnuradio.pager.flex_sync - gnuradio.pager.pager_flex_frame - gnuradio.pager.slicer_fb - -Utility Functions ------------------ - -.. autofunction:: gnuradio.pager.queue_runner diff --git a/docs/sphinx/source/pager/blks.rst b/docs/sphinx/source/pager_blocks.rst index 9b5a2ca70d..5eef083aa5 100644 --- a/docs/sphinx/source/pager/blks.rst +++ b/docs/sphinx/source/pager_blocks.rst @@ -1,8 +1,9 @@ -gnuradio.pager: Signal Processing Blocks -======================================== +gnuradio.pager +============== + +.. automodule:: gnuradio.pager .. autoblock:: gnuradio.pager.flex_deinterleave -.. autopyblock:: gnuradio.pager.flex_demod .. autoblock:: gnuradio.pager.flex_frame .. autoblock:: gnuradio.pager.flex_parse .. autoblock:: gnuradio.pager.flex_sync diff --git a/docs/sphinx/source/plot_data.rst b/docs/sphinx/source/plot_data.rst deleted file mode 100644 index 1b52a083c0..0000000000 --- a/docs/sphinx/source/plot_data.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.plot_data -================== - -.. automodule:: gnuradio.plot_data - -.. autoclass:: gnuradio.plot_data.plot_data diff --git a/docs/sphinx/source/pmt.rst b/docs/sphinx/source/pmt.rst new file mode 100644 index 0000000000..2520343cbd --- /dev/null +++ b/docs/sphinx/source/pmt.rst @@ -0,0 +1,193 @@ +gnuradio.pmt +============ + +.. autofunction:: pmt.acons +.. autofunction:: pmt.any_ref +.. autofunction:: pmt.any_set +.. autofunction:: pmt.assoc +.. autofunction:: pmt.assq +.. autofunction:: pmt.assv +.. autofunction:: pmt.blob_data +.. autofunction:: pmt.blob_length +.. autofunction:: pmt.c32vector_elements +.. autofunction:: pmt.c32vector_ref +.. autofunction:: pmt.c32vector_set +.. autofunction:: pmt.c64vector_elements +.. autofunction:: pmt.c64vector_ref +.. autofunction:: pmt.c64vector_set +.. autofunction:: pmt.caar +.. autofunction:: pmt.cadddr +.. autofunction:: pmt.caddr +.. autofunction:: pmt.cadr +.. autofunction:: pmt.car +.. autofunction:: pmt.cdar +.. autofunction:: pmt.cddr +.. autofunction:: pmt.cdr +.. autofunction:: pmt.cons +.. autofunction:: pmt.deserialize +.. autofunction:: pmt.deserialize_str +.. autofunction:: pmt.dict_add +.. autofunction:: pmt.dict_delete +.. autofunction:: pmt.dict_has_key +.. autofunction:: pmt.dict_items +.. autofunction:: pmt.dict_keys +.. autofunction:: pmt.dict_ref +.. autofunction:: pmt.dict_update +.. autofunction:: pmt.dict_values +.. autofunction:: pmt.dump_sizeof +.. autofunction:: pmt.eq +.. autofunction:: pmt.equal +.. autofunction:: pmt.eqv +.. autofunction:: pmt.f32vector_elements +.. autofunction:: pmt.f32vector_ref +.. autofunction:: pmt.f32vector_set +.. autofunction:: pmt.f64vector_elements +.. autofunction:: pmt.f64vector_ref +.. autofunction:: pmt.f64vector_set +.. autofunction:: pmt.from_bool +.. autofunction:: pmt.from_complex +.. autofunction:: pmt.from_double +.. autofunction:: pmt.from_float +.. autofunction:: pmt.from_long +.. autofunction:: pmt.from_uint64 +.. autofunction:: pmt.get_PMT_EOF +.. autofunction:: pmt.get_PMT_F +.. autofunction:: pmt.get_PMT_NIL +.. autofunction:: pmt.get_PMT_T +.. autofunction:: pmt.init_c32vector +.. autofunction:: pmt.init_c64vector +.. autofunction:: pmt.init_f32vector +.. autofunction:: pmt.init_f64vector +.. autofunction:: pmt.init_s16vector +.. autofunction:: pmt.init_s32vector +.. autofunction:: pmt.init_s8vector +.. autofunction:: pmt.init_u16vector +.. autofunction:: pmt.init_u32vector +.. autofunction:: pmt.init_u8vector +.. autofunction:: pmt.intern +.. autofunction:: pmt.is_any +.. autofunction:: pmt.is_blob +.. autofunction:: pmt.is_bool +.. autofunction:: pmt.is_c32vector +.. autofunction:: pmt.is_c64vector +.. autofunction:: pmt.is_complex +.. autofunction:: pmt.is_dict +.. autofunction:: pmt.is_eof_object +.. autofunction:: pmt.is_f32vector +.. autofunction:: pmt.is_f64vector +.. autofunction:: pmt.is_false +.. autofunction:: pmt.is_integer +.. autofunction:: pmt.is_msg_accepter +.. autofunction:: pmt.is_null +.. autofunction:: pmt.is_number +.. autofunction:: pmt.is_pair +.. autofunction:: pmt.is_real +.. autofunction:: pmt.is_s16vector +.. autofunction:: pmt.is_s32vector +.. autofunction:: pmt.is_s64vector +.. autofunction:: pmt.is_s8vector +.. autofunction:: pmt.is_symbol +.. autofunction:: pmt.is_true +.. autofunction:: pmt.is_tuple +.. autofunction:: pmt.is_u16vector +.. autofunction:: pmt.is_u32vector +.. autofunction:: pmt.is_u64vector +.. autofunction:: pmt.is_u8vector +.. autofunction:: pmt.is_uint64 +.. autofunction:: pmt.is_uniform_vector +.. autofunction:: pmt.is_vector +.. autofunction:: pmt.length +.. autofunction:: pmt.list1 +.. autofunction:: pmt.list2 +.. autofunction:: pmt.list3 +.. autofunction:: pmt.list4 +.. autofunction:: pmt.list5 +.. autofunction:: pmt.list6 +.. autofunction:: pmt.list_add +.. autofunction:: pmt.list_has +.. autofunction:: pmt.list_rm +.. autofunction:: pmt.make_any +.. autofunction:: pmt.make_blob +.. autofunction:: pmt.make_c32vector +.. autofunction:: pmt.make_c64vector +.. autofunction:: pmt.make_dict +.. autofunction:: pmt.make_f32vector +.. autofunction:: pmt.make_f64vector +.. autofunction:: pmt.make_msg_accepter +.. autofunction:: pmt.make_rectangular +.. autofunction:: pmt.make_s16vector +.. autofunction:: pmt.make_s32vector +.. autofunction:: pmt.make_s64vector +.. autofunction:: pmt.make_s8vector +.. autofunction:: pmt.make_tuple +.. autofunction:: pmt.make_u16vector +.. autofunction:: pmt.make_u32vector +.. autofunction:: pmt.make_u64vector +.. autofunction:: pmt.make_u8vector +.. autofunction:: pmt.make_vector +.. autofunction:: pmt.map +.. autofunction:: pmt.member +.. autofunction:: pmt.memq +.. autofunction:: pmt.memv +.. autofunction:: pmt.msg_accepter_ref +.. autofunction:: pmt.nth +.. autofunction:: pmt.nthcdr +.. autofunction:: pmt.pmt_vector_cdouble +.. autofunction:: pmt.pmt_vector_cfloat +.. autofunction:: pmt.pmt_vector_double +.. autofunction:: pmt.pmt_vector_float +.. autofunction:: pmt.pmt_vector_int16 +.. autofunction:: pmt.pmt_vector_int32 +.. autofunction:: pmt.pmt_vector_int8 +.. autofunction:: pmt.pmt_vector_uint16 +.. autofunction:: pmt.pmt_vector_uint32 +.. autofunction:: pmt.pmt_vector_uint8 +.. autofunction:: pmt.read +.. autofunction:: pmt.reverse +.. autofunction:: pmt.reverse_x +.. autofunction:: pmt.s16vector_elements +.. autofunction:: pmt.s16vector_ref +.. autofunction:: pmt.s16vector_set +.. autofunction:: pmt.s32vector_elements +.. autofunction:: pmt.s32vector_ref +.. autofunction:: pmt.s32vector_set +.. autofunction:: pmt.s64vector_ref +.. autofunction:: pmt.s64vector_set +.. autofunction:: pmt.s8vector_elements +.. autofunction:: pmt.s8vector_ref +.. autofunction:: pmt.s8vector_set +.. autofunction:: pmt.serialize +.. autofunction:: pmt.serialize_str +.. autofunction:: pmt.set_car +.. autofunction:: pmt.set_cdr +.. autofunction:: pmt.string_to_symbol +.. autofunction:: pmt.subsetp +.. autofunction:: pmt.symbol_to_string +.. autofunction:: pmt.to_bool +.. autofunction:: pmt.to_complex +.. autofunction:: pmt.to_double +.. autofunction:: pmt.to_float +.. autofunction:: pmt.to_long +.. autofunction:: pmt.to_pmt +.. autofunction:: pmt.to_python +.. autofunction:: pmt.to_tuple +.. autofunction:: pmt.to_uint64 +.. autofunction:: pmt.tuple_ref +.. autofunction:: pmt.u16vector_elements +.. autofunction:: pmt.u16vector_ref +.. autofunction:: pmt.u16vector_set +.. autofunction:: pmt.u32vector_elements +.. autofunction:: pmt.u32vector_ref +.. autofunction:: pmt.u32vector_set +.. autofunction:: pmt.u64vector_ref +.. autofunction:: pmt.u64vector_set +.. autofunction:: pmt.u8vector_elements +.. autofunction:: pmt.u8vector_ref +.. autofunction:: pmt.u8vector_set +.. autofunction:: pmt.uniform_vector_elements +.. autofunction:: pmt.uniform_vector_itemsize +.. autofunction:: pmt.vector_fill +.. autofunction:: pmt.vector_ref +.. autofunction:: pmt.vector_set +.. autofunction:: pmt.write +.. autofunction:: pmt.write_string diff --git a/docs/sphinx/source/pmt/any.rst b/docs/sphinx/source/pmt/any.rst deleted file mode 100644 index 05c02d5363..0000000000 --- a/docs/sphinx/source/pmt/any.rst +++ /dev/null @@ -1,7 +0,0 @@ -pmt: Any -======== - -.. autofunction:: pmt.is_any -.. autofunction:: pmt.make_any -.. autofunction:: pmt.any_ref -.. autofunction:: pmt.any_set diff --git a/docs/sphinx/source/pmt/boolean.rst b/docs/sphinx/source/pmt/boolean.rst deleted file mode 100644 index 8663daa438..0000000000 --- a/docs/sphinx/source/pmt/boolean.rst +++ /dev/null @@ -1,8 +0,0 @@ -pmt: Booleans -============= - -.. autofunction:: pmt.is_bool -.. autofunction:: pmt.is_true -.. autofunction:: pmt.is_false -.. autofunction:: pmt.from_bool -.. autofunction:: pmt.to_bool diff --git a/docs/sphinx/source/pmt/dictionary.rst b/docs/sphinx/source/pmt/dictionary.rst deleted file mode 100644 index 7909da8d9e..0000000000 --- a/docs/sphinx/source/pmt/dictionary.rst +++ /dev/null @@ -1,12 +0,0 @@ -pmt: Dictionary -=============== - -.. autofunction:: pmt.is_dict -.. autofunction:: pmt.make_dict -.. autofunction:: pmt.dict_add -.. autofunction:: pmt.dict_delete -.. autofunction:: pmt.dict_has_key -.. autofunction:: pmt.dict_ref -.. autofunction:: pmt.dict_items -.. autofunction:: pmt.dict_keys -.. autofunction:: pmt.dict_values diff --git a/docs/sphinx/source/pmt/generalfunctions.rst b/docs/sphinx/source/pmt/generalfunctions.rst deleted file mode 100644 index 58b13c750d..0000000000 --- a/docs/sphinx/source/pmt/generalfunctions.rst +++ /dev/null @@ -1,31 +0,0 @@ -pmt: General Functions -====================== - - pmt.map - pmt.reverse - pmt.reverse_x - pmt.acons - pmt.nth - pmt.nthcdr - pmt.memq - pmt.memv - pmt.member - pmt.subsetp - pmt.list1 - pmt.list2 - pmt.list3 - pmt.list4 - pmt.list5 - pmt.list6 - pmt.list_add - pmt.list_rm - pmt.list_has - -.. autofunction:: pmt.eq -.. autofunction:: pmt.equal -.. autofunction:: pmt.eqv -.. autofunction:: pmt.length -.. autofunction:: pmt.assq -.. autofunction:: pmt.assv -.. autofunction:: pmt.assoc - diff --git a/docs/sphinx/source/pmt/index.rst b/docs/sphinx/source/pmt/index.rst deleted file mode 100644 index fd90a3d605..0000000000 --- a/docs/sphinx/source/pmt/index.rst +++ /dev/null @@ -1,347 +0,0 @@ -pmt -=== - -.. automodule:: pmt - -Boolean -------- - -.. autosummary:: - :nosignatures: - - pmt.is_bool - pmt.is_true - pmt.is_false - pmt.from_bool - pmt.to_bool - -Symbols -------- - -.. autosummary:: - :nosignatures: - - pmt.is_symbol - pmt.string_to_symbol - pmt.symbol_to_string - pmt.intern - -Numbers -------- - -.. autosummary:: - :nosignatures: - - pmt.is_number - -Integers --------- - -.. autosummary:: - :nosignatures: - - pmt.is_integer - pmt.to_long - pmt.from_long - -uint64_t ---------- - -.. autosummary:: - :nosignatures: - - pmt.is_uint64 - pmt.to_uint64 - pmt.from_uint64 - -Reals ------ - -.. autosummary:: - :nosignatures: - - pmt.is_real - pmt.to_double - pmt.from_double - -Complex -------- - -.. autosummary:: - :nosignatures: - - pmt.is_complex - pmt.to_complex - pmt.from_complex - pmt.make_rectangular - -Pairs ------ - -.. autosummary:: - :nosignatures: - - pmt.is_pair - pmt.cons - pmt.car - pmt.cdr - pmt.set_car - pmt.set_cdr - pmt.caar - pmt.cadddr - pmt.caddr - pmt.cadr - pmt.cdar - pmt.cddr - -Tuples ------- - -.. autosummary:: - :nosignatures: - - pmt.is_tuple - pmt.make_tuple - pmt.tuple_ref - pmt.to_tuple - -Vectors -------- - -.. autosummary:: - :nosignatures: - - pmt.is_vector - pmt.make_vector - pmt.vector_ref - pmt.vector_set - pmt.vector_fill - -BLOBs ------ - -.. autosummary:: - :nosignatures: - - pmt.is_blob - pmt.make_blob - pmt.blob_data - pmt.blob_length - -Uniform Numeric Vectors ------------------------ - -.. autosummary:: - :nosignatures: - - pmt.is_uniform_vector - pmt.is_u8vector - pmt.is_u16vector - pmt.is_u32vector - pmt.is_u64vector - pmt.is_s16vector - pmt.is_s32vector - pmt.is_s64vector - pmt.is_s8vector - pmt.is_c32vector - pmt.is_c64vector - pmt.is_f32vector - pmt.is_f64vector - - pmt.make_u8vector - pmt.make_u16vector - pmt.make_u32vector - pmt.make_u64vector - pmt.make_s8vector - pmt.make_s16vector - pmt.make_s32vector - pmt.make_s64vector - pmt.make_c32vector - pmt.make_c64vector - pmt.make_f32vector - pmt.make_f64vector - - pmt.init_u8vector - pmt.init_u16vector - pmt.init_u32vector - pmt.init_u64vector - - pmt.init_s8vector - pmt.init_s16vector - pmt.init_s32vector - pmt.init_s64vector - pmt.init_c32vector - pmt.init_c64vector - pmt.init_f32vector - pmt.init_f64vector - - pmt.c32vector_ref - pmt.c64vector_ref - pmt.f32vector_ref - pmt.f64vector_ref - pmt.s16vector_ref - pmt.s32vector_ref - pmt.s64vector_ref - pmt.s8vector_ref - pmt.u16vector_ref - pmt.u32vector_ref - pmt.u64vector_ref - pmt.u8vector_ref - - pmt.c32vector_set - pmt.c64vector_set - pmt.f32vector_set - pmt.f64vector_set - pmt.s16vector_set - pmt.s32vector_set - pmt.s64vector_set - pmt.s8vector_set - pmt.u16vector_set - pmt.u32vector_set - pmt.u64vector_set - pmt.u8vector_set - - pmt.uniform_vector_elements - - pmt.c32vector_elements - pmt.c64vector_elements - pmt.f32vector_elements - pmt.f64vector_elements - pmt.s16vector_elements - pmt.s32vector_elements - pmt.s8vector_elements - pmt.u16vector_elements - pmt.u32vector_elements - pmt.u8vector_elements - -Dictionary ----------- - -.. autosummary:: - :nosignatures: - - pmt.is_dict - pmt.make_dict - pmt.dict_add - pmt.dict_delete - pmt.dict_has_key - pmt.dict_ref - pmt.dict_items - pmt.dict_keys - pmt.dict_values - -Any ---- - -.. autosummary:: - :nosignatures: - - pmt.is_any - pmt.make_any - pmt.any_ref - pmt.any_set - -Message Accepter ----------------- - -.. autosummary:: - :nosignatures: - - pmt.is_msg_accepter - pmt.make_msg_accepter - pmt.msg_accepter_ref - -General Functions ------------------ - -.. autosummary:: - :nosignatures: - - pmt.eq - pmt.equal - pmt.eqv - pmt.length - pmt.assq - pmt.assv - pmt_assoc - -Lists ------ - -.. autosummary:: - :nosignatures: - - pmt.map - pmt.reverse - pmt.reverse_x - pmt.acons - pmt.nth - pmt.nthcdr - pmt.memq - pmt.memv - pmt.member - pmt.subsetp - pmt.list1 - pmt.list2 - pmt.list3 - pmt.list4 - pmt.list5 - pmt.list6 - pmt.list_add - pmt.list_rm - pmt.list_has - -Read/Write ----------- - -.. autosummary:: - :nosignatures: - - pmt.is_eof_object - pmt.read - pmt.write - pmt.write_string - -Serialize ---------- - -.. autosummary:: - :nosignatures: - - pmt.serialize - pmt.deserialize - pmt.dump_sizeof - pmt.serialize_str - pmt.deserialize_str - -Misc ----- - -.. autosummary:: - :nosignatures: - - pmt.is_null - pmt.cvar - -Generic Casts -------------- - -.. autosummary:: - :nosignatures: - - pmt.to_pmt - pmt.to_python - pmt.pmt_to_python.pmt_to_python - -Constants --------- - -.. autosummary:: - :nosignatures: - - pmt.PMT_EOF - pmt.PMT_EOF - pmt.PMT_F - pmt.PMT_NIL - pmt.PMT_T - diff --git a/docs/sphinx/source/pmt/integer.rst b/docs/sphinx/source/pmt/integer.rst deleted file mode 100644 index 58e16e5aa7..0000000000 --- a/docs/sphinx/source/pmt/integer.rst +++ /dev/null @@ -1,13 +0,0 @@ -pmt: Integers -============= - -.. autofunction:: pmt.is_integer -.. autofunction:: pmt.to_long -.. autofunction:: pmt.from_long - - -pmt: uint64_t -============= -.. autofunction:: pmt.is_uint64 -.. autofunction:: pmt.to_uint64 -.. autofunction:: pmt.from_uint64 diff --git a/docs/sphinx/source/pmt/list.rst b/docs/sphinx/source/pmt/list.rst deleted file mode 100644 index 8b67119910..0000000000 --- a/docs/sphinx/source/pmt/list.rst +++ /dev/null @@ -1,22 +0,0 @@ -pmt: Lists -========== - -.. autofunction:: pmt.map -.. autofunction:: pmt.reverse -.. autofunction:: pmt.reverse_x -.. autofunction:: pmt.acons -.. autofunction:: pmt.nth -.. autofunction:: pmt.nthcdr -.. autofunction:: pmt.memq -.. autofunction:: pmt.memv -.. autofunction:: pmt.member -.. autofunction:: pmt.subsetp -.. autofunction:: pmt.list1 -.. autofunction:: pmt.list2 -.. autofunction:: pmt.list3 -.. autofunction:: pmt.list4 -.. autofunction:: pmt.list5 -.. autofunction:: pmt.list6 -.. autofunction:: pmt.list_add -.. autofunction:: pmt.list_rm -.. autofunction:: pmt.list_has diff --git a/docs/sphinx/source/pmt/message_accepter.rst b/docs/sphinx/source/pmt/message_accepter.rst deleted file mode 100644 index 066203c713..0000000000 --- a/docs/sphinx/source/pmt/message_accepter.rst +++ /dev/null @@ -1,7 +0,0 @@ -pmt: Message Accepter -===================== - -.. autofunction:: pmt.is_msg_accepter -.. autofunction:: pmt.make_msg_accepter -.. autofunction:: pmt.msg_accepter_ref - diff --git a/docs/sphinx/source/pmt/misc.rst b/docs/sphinx/source/pmt/misc.rst deleted file mode 100644 index c671540fe2..0000000000 --- a/docs/sphinx/source/pmt/misc.rst +++ /dev/null @@ -1,22 +0,0 @@ -pmt: Misc -========= - -.. autofunction:: pmt.is_null -.. autofunction:: pmt.cvar - -pmt: Generic Casts -================== - -.. autofunction:: pmt.to_pmt -.. autofunction:: pmt.to_python -.. autofunction:: pmt.pmt_to_python.pmt_to_python - -pmt: Constants -============== - -.. autofunction:: pmt.PMT_EOF -.. autofunction:: pmt.PMT_EOF -.. autofunction:: pmt.PMT_F -.. autofunction:: pmt.PMT_NIL -.. autofunction:: pmt.PMT_T - diff --git a/docs/sphinx/source/pmt/number.rst b/docs/sphinx/source/pmt/number.rst deleted file mode 100644 index 226195a4be..0000000000 --- a/docs/sphinx/source/pmt/number.rst +++ /dev/null @@ -1,4 +0,0 @@ -pmt: Numbers -============ - -.. autofunction:: pmt.is_number diff --git a/docs/sphinx/source/pmt/pair.rst b/docs/sphinx/source/pmt/pair.rst deleted file mode 100644 index 0bcd998143..0000000000 --- a/docs/sphinx/source/pmt/pair.rst +++ /dev/null @@ -1,15 +0,0 @@ -pmt: Pairs -========== - -.. autofunction:: pmt.is_pair -.. autofunction:: pmt.cons -.. autofunction:: pmt.car -.. autofunction:: pmt.cdr -.. autofunction:: pmt.set_car -.. autofunction:: pmt.set_cdr -.. autofunction:: pmt.caar -.. autofunction:: pmt.cadddr -.. autofunction:: pmt.caddr -.. autofunction:: pmt.cadr -.. autofunction:: pmt.cdar -.. autofunction:: pmt.cddr diff --git a/docs/sphinx/source/pmt/readwrite.rst b/docs/sphinx/source/pmt/readwrite.rst deleted file mode 100644 index 2e3d6ca00a..0000000000 --- a/docs/sphinx/source/pmt/readwrite.rst +++ /dev/null @@ -1,7 +0,0 @@ -pmt: Read/Write -=============== - -.. autofunction:: pmt.is_eof_object -.. autofunction:: pmt.read -.. autofunction:: pmt.write -.. autofunction:: pmt.write_string diff --git a/docs/sphinx/source/pmt/real.rst b/docs/sphinx/source/pmt/real.rst deleted file mode 100644 index 9ec783c870..0000000000 --- a/docs/sphinx/source/pmt/real.rst +++ /dev/null @@ -1,14 +0,0 @@ -pmt: Reals -========== - -.. autofunction:: pmt.is_real -.. autofunction:: pmt.to_double -.. autofunction:: pmt.from_double - - -pmt: Complex -============ -.. autofunction:: pmt.is_complex -.. autofunction:: pmt.to_complex -.. autofunction:: pmt.from_complex -.. autofunction:: pmt.make_rectangular diff --git a/docs/sphinx/source/pmt/serialize.rst b/docs/sphinx/source/pmt/serialize.rst deleted file mode 100644 index 506180d0df..0000000000 --- a/docs/sphinx/source/pmt/serialize.rst +++ /dev/null @@ -1,8 +0,0 @@ -pmt: Serialize -============== - -.. autofunction:: pmt.serialize -.. autofunction:: pmt.deserialize -.. autofunction:: pmt.dump_sizeof -.. autofunction:: pmt.serialize_str -.. autofunction:: pmt.deserialize_str diff --git a/docs/sphinx/source/pmt/symbol.rst b/docs/sphinx/source/pmt/symbol.rst deleted file mode 100644 index ab74b8662e..0000000000 --- a/docs/sphinx/source/pmt/symbol.rst +++ /dev/null @@ -1,7 +0,0 @@ -pmt: Symbols -============ - -.. autofunction:: pmt.is_symbol -.. autofunction:: pmt.string_to_symbol -.. autofunction:: pmt.symbol_to_string -.. autofunction:: pmt.intern diff --git a/docs/sphinx/source/pmt/tuple.rst b/docs/sphinx/source/pmt/tuple.rst deleted file mode 100644 index 568305ae06..0000000000 --- a/docs/sphinx/source/pmt/tuple.rst +++ /dev/null @@ -1,7 +0,0 @@ -pmt: BLOBs -========== - -.. autofunction:: pmt.is_blob -.. autofunction:: pmt.make_blob -.. autofunction:: pmt.blob_data -.. autofunction:: pmt.blob_length diff --git a/docs/sphinx/source/pmt/vector.rst b/docs/sphinx/source/pmt/vector.rst deleted file mode 100644 index fba34a21bb..0000000000 --- a/docs/sphinx/source/pmt/vector.rst +++ /dev/null @@ -1,92 +0,0 @@ -pmt: Vectors -============ - -.. autofunction:: pmt.is_vector -.. autofunction:: pmt.make_vector -.. autofunction:: pmt.vector_ref -.. autofunction:: pmt.vector_set -.. autofunction:: pmt.vector_fill - -pmt: Uniform Numeric Vectors -============================ - -.. autofunction:: pmt.is_uniform_vector -.. autofunction:: pmt.is_u8vector -.. autofunction:: pmt.is_u16vector -.. autofunction:: pmt.is_u32vector -.. autofunction:: pmt.is_u64vector -.. autofunction:: pmt.is_s16vector -.. autofunction:: pmt.is_s32vector -.. autofunction:: pmt.is_s64vector -.. autofunction:: pmt.is_s8vector -.. autofunction:: pmt.is_c32vector -.. autofunction:: pmt.is_c64vector -.. autofunction:: pmt.is_f32vector -.. autofunction:: pmt.is_f64vector - -.. autofunction:: pmt.make_u8vector -.. autofunction:: pmt.make_u16vector -.. autofunction:: pmt.make_u32vector -.. autofunction:: pmt.make_u64vector -.. autofunction:: pmt.make_s8vector -.. autofunction:: pmt.make_s16vector -.. autofunction:: pmt.make_s32vector -.. autofunction:: pmt.make_s64vector -.. autofunction:: pmt.make_c32vector -.. autofunction:: pmt.make_c64vector -.. autofunction:: pmt.make_f32vector -.. autofunction:: pmt.make_f64vector - -.. autofunction:: pmt.init_u8vector -.. autofunction:: pmt.init_u16vector -.. autofunction:: pmt.init_u32vector -.. autofunction:: pmt.init_u64vector - -.. autofunction:: pmt.init_s8vector -.. autofunction:: pmt.init_s16vector -.. autofunction:: pmt.init_s32vector -.. autofunction:: pmt.init_s64vector -.. autofunction:: pmt.init_c32vector -.. autofunction:: pmt.init_c64vector -.. autofunction:: pmt.init_f32vector -.. autofunction:: pmt.init_f64vector - -.. autofunction:: pmt.c32vector_ref -.. autofunction:: pmt.c64vector_ref -.. autofunction:: pmt.f32vector_ref -.. autofunction:: pmt.f64vector_ref -.. autofunction:: pmt.s16vector_ref -.. autofunction:: pmt.s32vector_ref -.. autofunction:: pmt.s64vector_ref -.. autofunction:: pmt.s8vector_ref -.. autofunction:: pmt.u16vector_ref -.. autofunction:: pmt.u32vector_ref -.. autofunction:: pmt.u64vector_ref -.. autofunction:: pmt.u8vector_ref - -.. autofunction:: pmt.c32vector_set -.. autofunction:: pmt.c64vector_set -.. autofunction:: pmt.f32vector_set -.. autofunction:: pmt.f64vector_set -.. autofunction:: pmt.s16vector_set -.. autofunction:: pmt.s32vector_set -.. autofunction:: pmt.s64vector_set -.. autofunction:: pmt.s8vector_set -.. autofunction:: pmt.u16vector_set -.. autofunction:: pmt.u32vector_set -.. autofunction:: pmt.u64vector_set -.. autofunction:: pmt.u8vector_set - -.. autofunction:: pmt.uniform_vector_elements - -.. autofunction:: pmt.c32vector_elements -.. autofunction:: pmt.c64vector_elements -.. autofunction:: pmt.f32vector_elements -.. autofunction:: pmt.f64vector_elements -.. autofunction:: pmt.s16vector_elements -.. autofunction:: pmt.s32vector_elements -.. autofunction:: pmt.s8vector_elements -.. autofunction:: pmt.u16vector_elements -.. autofunction:: pmt.u32vector_elements -.. autofunction:: pmt.u8vector_elements - diff --git a/docs/sphinx/source/pyqt_filter.rst b/docs/sphinx/source/pyqt_filter.rst deleted file mode 100644 index cc52abfa79..0000000000 --- a/docs/sphinx/source/pyqt_filter.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.pyqt_filter -==================== - -.. automodule:: gnuradio.pyqt_filter - -.. autoclass:: gnuradio.pyqt_filter.Ui_MainWindow diff --git a/docs/sphinx/source/pyqt_plot.rst b/docs/sphinx/source/pyqt_plot.rst deleted file mode 100644 index 3537a080bc..0000000000 --- a/docs/sphinx/source/pyqt_plot.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.pyqt_plot -================== - -.. automodule:: gnuradio.pyqt_plot - -.. autoclass:: gnuradio.pyqt_plot.Ui_MainWindow diff --git a/docs/sphinx/source/qtgui/index.rst b/docs/sphinx/source/qtgui/index.rst deleted file mode 100644 index c6311d381a..0000000000 --- a/docs/sphinx/source/qtgui/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -gnuradio.qtgui -============== - -.. automodule:: gnuradio.qtgui - -.. autoblock:: gnuradio.qtgui.sink_c -.. autoblock:: gnuradio.qtgui.sink_f -.. autoblock:: gnuradio.qtgui.time_sink_c -.. autoblock:: gnuradio.qtgui.time_sink_f diff --git a/docs/sphinx/source/qtgui_blocks.rst b/docs/sphinx/source/qtgui_blocks.rst new file mode 100644 index 0000000000..4e0910d179 --- /dev/null +++ b/docs/sphinx/source/qtgui_blocks.rst @@ -0,0 +1,20 @@ +gnuradio.qtgui +============== + +.. automodule:: gnuradio.qtgui + +.. autoblock:: gnuradio.qtgui.ber_sink_b +.. autoblock:: gnuradio.qtgui.const_sink_c +.. autoblock:: gnuradio.qtgui.freq_sink_c +.. autoblock:: gnuradio.qtgui.freq_sink_f +.. autoblock:: gnuradio.qtgui.histogram_sink_f +.. autoblock:: gnuradio.qtgui.number_sink +.. autoblock:: gnuradio.qtgui.sink_c +.. autoblock:: gnuradio.qtgui.sink_f +.. autoblock:: gnuradio.qtgui.time_raster_sink_b +.. autoblock:: gnuradio.qtgui.time_raster_sink_f +.. autoblock:: gnuradio.qtgui.time_sink_c +.. autoblock:: gnuradio.qtgui.time_sink_f +.. autoblock:: gnuradio.qtgui.vector_sink_f +.. autoblock:: gnuradio.qtgui.waterfall_sink_c +.. autoblock:: gnuradio.qtgui.waterfall_sink_f diff --git a/docs/sphinx/source/runtime.rst b/docs/sphinx/source/runtime.rst new file mode 100644 index 0000000000..b94dd90d5e --- /dev/null +++ b/docs/sphinx/source/runtime.rst @@ -0,0 +1,65 @@ +gnuradio.gr +=========== + +.. autoclass:: gnuradio.gr.top_block + +.. autoclass:: gnuradio.gr.basic_block +.. autoclass:: gnuradio.gr.block +.. autoclass:: gnuradio.gr.sync_block +.. autoclass:: gnuradio.gr.sync_decimator +.. autoclass:: gnuradio.gr.sync_interpolator +.. autoclass:: gnuradio.gr.tagged_stream_block +.. autoclass:: gnuradio.gr.hier_block2 + +.. autofunction:: gnuradio.gr.high_res_timer_now +.. autofunction:: gnuradio.gr.high_res_timer_now_perfmon +.. autofunction:: gnuradio.gr.high_res_timer_epoch +.. autofunction:: gnuradio.gr.high_res_timer_tps + +.. autoclass:: gnuradio.gr.io_signature +.. autoclass:: gnuradio.gr.io_signature2 +.. autoclass:: gnuradio.gr.io_signature3 +.. autoclass:: gnuradio.gr.io_signaturev + +.. autofunction:: gnuradio.gr.prefix +.. autofunction:: gnuradio.gr.prefsdir +.. autofunction:: gnuradio.gr.sysconfdir +.. autofunction:: gnuradio.gr.version +.. autofunction:: gnuradio.gr.major_version +.. autofunction:: gnuradio.gr.api_version +.. autofunction:: gnuradio.gr.minor_version +.. autoclass:: gnuradio.gr.prefs +.. autoclass:: gnuradio.gr.logger +.. autofunction:: gnuradio.gr.logger_config +.. autofunction:: gnuradio.gr.logger_get_names +.. autofunction:: gnuradio.gr.logger_reset_config + +.. autoclass:: gnuradio.gr.tag_t +.. autofunction:: gnuradio.gr.tag_t_offset_compare +.. autofunction:: gnuradio.gr.tag_t_offset_compare_key +.. autofunction:: gnuradio.gr.tag_to_pmt +.. autofunction:: gnuradio.gr.tag_to_python +.. autoclass:: gnuradio.gr.tag_utils + +.. autoclass:: gnuradio.gr.sizeof_gr_complex +.. autoclass:: gnuradio.gr.sizeof_float +.. autoclass:: gnuradio.gr.sizeof_int +.. autoclass:: gnuradio.gr.sizeof_short +.. autoclass:: gnuradio.gr.sizeof_char +.. autoclass:: gnuradio.gr.sizeof_double + +.. autofunction:: gnuradio.gr.branchless_binary_slicer +.. autofunction:: gnuradio.gr.binary_slicer +.. autofunction:: gnuradio.gr.branchless_clip +.. autofunction:: gnuradio.gr.clip +.. autofunction:: gnuradio.gr.branchless_quad_0deg_slicer +.. autofunction:: gnuradio.gr.quad_0deg_slicer +.. autofunction:: gnuradio.gr.branchless_quad_45deg_slicer +.. autofunction:: gnuradio.gr.quad_45deg_slicer + +.. autoclass:: gnuradio.gr.feval +.. autoclass:: gnuradio.gr.feval_cc +.. autoclass:: gnuradio.gr.feval_dd +.. autoclass:: gnuradio.gr.feval_ll +.. autoclass:: gnuradio.gr.feval_p +.. autoclass:: gnuradio.gr.gateway diff --git a/docs/sphinx/source/trellis/objs.rst b/docs/sphinx/source/trellis.rst index b3a4b7a4ae..71a37b3e88 100644 --- a/docs/sphinx/source/trellis/objs.rst +++ b/docs/sphinx/source/trellis.rst @@ -1,5 +1,5 @@ -gnuradio.trellis: Object Classes --------------------------------- +gnuradio.trellis +================ .. autoclass:: gnuradio.trellis.fsm .. autoclass:: gnuradio.trellis.interleaver 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 - - diff --git a/docs/sphinx/source/trellis/blks.rst b/docs/sphinx/source/trellis_blocks.rst index a2eda07d61..a872894a50 100644 --- a/docs/sphinx/source/trellis/blks.rst +++ b/docs/sphinx/source/trellis_blocks.rst @@ -1,5 +1,7 @@ -gnuradio.trellis: Signal Processing Blocks -========================================== +gnuradio.trellis +================ + +.. automodule:: gnuradio.trellis .. autoblock:: gnuradio.trellis.constellation_metrics_cf .. autoblock:: gnuradio.trellis.encoder_bb diff --git a/docs/sphinx/source/uhd.rst b/docs/sphinx/source/uhd.rst index 1f381e23b9..a9669622c6 100644 --- a/docs/sphinx/source/uhd.rst +++ b/docs/sphinx/source/uhd.rst @@ -1,18 +1,4 @@ gnuradio.uhd ============ -.. automodule:: gnuradio.uhd - -.. autoblock:: gnuradio.uhd.usrp_sink -.. autoblock:: gnuradio.uhd.usrp_source -.. autoblock:: gnuradio.uhd.amsg_source -.. autoclass:: gnuradio.uhd.stream_cmd_t -.. autoclass:: gnuradio.uhd.time_spec_t -.. autoclass:: gnuradio.uhd.meta_range_t -.. autoclass:: gnuradio.uhd.stream_args_t -.. autoclass:: gnuradio.uhd.device_addr_t -.. autoclass:: gnuradio.uhd.tune_request_t -.. autoclass:: gnuradio.uhd.tune_result_t -.. autoclass:: gnuradio.uhd.sensor_value_t - - +.. autoclass:: gnuradio.uhd.usrp_block diff --git a/docs/sphinx/source/uhd_blocks.rst b/docs/sphinx/source/uhd_blocks.rst new file mode 100644 index 0000000000..c9da6ccddb --- /dev/null +++ b/docs/sphinx/source/uhd_blocks.rst @@ -0,0 +1,8 @@ +gnuradio.uhd +============ + +.. automodule:: gnuradio.uhd + +.. autoblock:: gnuradio.uhd.amsg_source +.. autoblock:: gnuradio.uhd.usrp_sink +.. autoblock:: gnuradio.uhd.usrp_source diff --git a/docs/sphinx/source/video_sdl.rst b/docs/sphinx/source/video_sdl_blocks.rst index e4fc5acac3..e4fc5acac3 100644 --- a/docs/sphinx/source/video_sdl.rst +++ b/docs/sphinx/source/video_sdl_blocks.rst diff --git a/docs/sphinx/source/vocoder.rst b/docs/sphinx/source/vocoder.rst new file mode 100644 index 0000000000..9ab29759f6 --- /dev/null +++ b/docs/sphinx/source/vocoder.rst @@ -0,0 +1,6 @@ +gnuradio.vocoder +================ + +.. autoclass:: gnuradio.vocoder.codec2 +.. autoclass:: gnuradio.vocoder.cvsd_encode_fb +.. autoclass:: gnuradio.vocoder.cvsd_decode_bf diff --git a/docs/sphinx/source/vocoder/index.rst b/docs/sphinx/source/vocoder/index.rst deleted file mode 100644 index 2e31809958..0000000000 --- a/docs/sphinx/source/vocoder/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -gnuradio.vocoder -================ - -.. automodule:: gnuradio.vocoder - -.. autosummary:: - :nosignatures: - - gnuradio.vocoder.alaw_decode_bs - gnuradio.vocoder.alaw_encode_sb - gnuradio.vocoder.codec2_decode_ps - gnuradio.vocoder.codec2_encode_sp - gnuradio.vocoder.cvsd_decode_bf - gnuradio.vocoder.cvsd_decode_bs - gnuradio.vocoder.cvsd_encode_fb - gnuradio.vocoder.cvsd_encode_sb - gnuradio.vocoder.g721_decode_bs - gnuradio.vocoder.g721_encode_sb - gnuradio.vocoder.g723_24_decode_bs - gnuradio.vocoder.g723_24_encode_sb - gnuradio.vocoder.g723_40_decode_bs - gnuradio.vocoder.g723_40_encode_sb - gnuradio.vocoder.gsm_fr_decode_ps - gnuradio.vocoder.gsm_fr_encode_sp - gnuradio.vocoder.ulaw_decode_bs - gnuradio.vocoder.ulaw_encode_sb diff --git a/docs/sphinx/source/vocoder/blks.rst b/docs/sphinx/source/vocoder_blocks.rst index ea20bc44be..ab8e5f650f 100644 --- a/docs/sphinx/source/vocoder/blks.rst +++ b/docs/sphinx/source/vocoder_blocks.rst @@ -1,6 +1,8 @@ gnuradio.vocoder ================ +.. automodule:: gnuradio.vocoder + .. autoblock:: gnuradio.vocoder.alaw_decode_bs .. autoblock:: gnuradio.vocoder.alaw_encode_sb .. autoblock:: gnuradio.vocoder.codec2_decode_ps diff --git a/docs/sphinx/source/wavelet.rst b/docs/sphinx/source/wavelet_blocks.rst index 679bab70c0..679bab70c0 100644 --- a/docs/sphinx/source/wavelet.rst +++ b/docs/sphinx/source/wavelet_blocks.rst diff --git a/docs/sphinx/source/wxgui.rst b/docs/sphinx/source/wxgui.rst new file mode 100644 index 0000000000..dcaa4a8e4a --- /dev/null +++ b/docs/sphinx/source/wxgui.rst @@ -0,0 +1,5 @@ +gnuradio.wxgui +============== + +.. autoclass:: gnuradio.wxgui.oscope_sink_x +.. autoclass:: gnuradio.wxgui.histo_sink_f diff --git a/docs/sphinx/source/wxgui/blks.rst b/docs/sphinx/source/wxgui/blks.rst deleted file mode 100644 index 930474ed19..0000000000 --- a/docs/sphinx/source/wxgui/blks.rst +++ /dev/null @@ -1,16 +0,0 @@ -gnuradio.wxgui -===================== - -.. autoblock:: gnuradio.wxgui.histo_sink_f -.. autoblock:: gnuradio.wxgui.oscope_sink_f - -.. autopyblock:: gnuradio.wxgui.constsink_gl.const_sink_c -.. autopyblock:: gnuradio.wxgui.fftsink2.fft_sink_c -.. autopyblock:: gnuradio.wxgui.fftsink2.fft_sink_f -.. autopyblock:: gnuradio.wxgui.histosink_gl.histo_sink_f -.. autopyblock:: gnuradio.wxgui.numbersink2.number_sink_c -.. autopyblock:: gnuradio.wxgui.numbersink2.number_sink_f -.. autopyblock:: gnuradio.wxgui.scopesink2.scope_sink_c -.. autopyblock:: gnuradio.wxgui.scopesink2.scope_sink_f -.. autopyblock:: gnuradio.wxgui.waterfallsink2.waterfall_sink_c -.. autopyblock:: gnuradio.wxgui.waterfallsink2.waterfall_sink_f diff --git a/docs/sphinx/source/wxgui/index.rst b/docs/sphinx/source/wxgui/index.rst deleted file mode 100644 index af0a34a483..0000000000 --- a/docs/sphinx/source/wxgui/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -gnuradio.wxgui -============== - -.. automodule:: gnuradio.wxgui - -.. autosummary:: - :nosignatures: - - gnuradio.wxgui.histo_sink_f - gnuradio.wxgui.oscope_sink_f - gnuradio.wxgui.common.const_sink_c - gnuradio.wxgui.fftsink2.fft_sink_c - gnuradio.wxgui.fftsink2.fft_sink_f - gnuradio.wxgui.histosink_gl.histosink_f - gnuradio.wxgui.numbersink2.number_sink_c - gnuradio.wxgui.numbersink2.number_sink_f - gnuradio.wxgui.scopesink2.scope_sink_c - gnuradio.wxgui.scopesink2.scope_sink_f - gnuradio.wxgui.waterfallsink2.waterfall_sink_c - gnuradio.wxgui.waterfallsink2.waterfall_sink_f diff --git a/docs/sphinx/source/wxgui_blocks.rst b/docs/sphinx/source/wxgui_blocks.rst new file mode 100644 index 0000000000..ccccd854da --- /dev/null +++ b/docs/sphinx/source/wxgui_blocks.rst @@ -0,0 +1,7 @@ +gnuradio.wxgui +============== + +.. automodule:: gnuradio.wxgui + +.. autoblock:: gnuradio.wxgui.histo_sink_f +.. autoblock:: gnuradio.wxgui.oscope_sink_f diff --git a/docs/sphinx/source/zeromq_blocks.rst b/docs/sphinx/source/zeromq_blocks.rst new file mode 100644 index 0000000000..add946ac1a --- /dev/null +++ b/docs/sphinx/source/zeromq_blocks.rst @@ -0,0 +1,17 @@ +gnuradio.zeromq +=============== + +.. automodule:: gnuradio.zeromq + +.. autoblock:: gnuradio.zeromq.pub_msg_sink +.. autoblock:: gnuradio.zeromq.pub_sink +.. autoblock:: gnuradio.zeromq.pull_msg_source +.. autoblock:: gnuradio.zeromq.pull_source +.. autoblock:: gnuradio.zeromq.push_msg_sink +.. autoblock:: gnuradio.zeromq.push_sink +.. autoblock:: gnuradio.zeromq.rep_msg_sink +.. autoblock:: gnuradio.zeromq.rep_sink +.. autoblock:: gnuradio.zeromq.req_msg_source +.. autoblock:: gnuradio.zeromq.req_source +.. autoblock:: gnuradio.zeromq.sub_msg_source +.. autoblock:: gnuradio.zeromq.sub_source |