diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-04-26 14:03:53 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-04-26 14:03:53 -0700 |
| commit | 112f81ddafea9fbf313eb790f228e4324d01382f (patch) | |
| tree | 6ef8a37571a2d9b6de33cec8bc104ff97fa67ca4 /docs/sphinx | |
| parent | 083c3980e60cb4c3e8211ef14918e985c5065241 (diff) | |
sphinx: Added sphinx source for gr-blocks.
Diffstat (limited to 'docs/sphinx')
21 files changed, 729 insertions, 0 deletions
diff --git a/docs/sphinx/source/blocks/audio_blk.rst b/docs/sphinx/source/blocks/audio_blk.rst new file mode 100644 index 0000000000..b73f9f3335 --- /dev/null +++ b/docs/sphinx/source/blocks/audio_blk.rst @@ -0,0 +1,5 @@ +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 new file mode 100644 index 0000000000..b6c2066d3e --- /dev/null +++ b/docs/sphinx/source/blocks/boolean_operators_blk.rst @@ -0,0 +1,18 @@ +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 new file mode 100644 index 0000000000..5ffc0e0ef7 --- /dev/null +++ b/docs/sphinx/source/blocks/byte_operators_blk.rst @@ -0,0 +1,12 @@ +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 new file mode 100644 index 0000000000..0931c210de --- /dev/null +++ b/docs/sphinx/source/blocks/controlport_blk.rst @@ -0,0 +1,5 @@ +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 new file mode 100644 index 0000000000..f655023d32 --- /dev/null +++ b/docs/sphinx/source/blocks/debug_tools_blk.rst @@ -0,0 +1,14 @@ +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 new file mode 100644 index 0000000000..a01d3a08c6 --- /dev/null +++ b/docs/sphinx/source/blocks/file_operators_blk.rst @@ -0,0 +1,10 @@ +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 new file mode 100644 index 0000000000..4ff9b1d10b --- /dev/null +++ b/docs/sphinx/source/blocks/get_blocks.py @@ -0,0 +1,106 @@ +""" +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 new file mode 100644 index 0000000000..2e29a5012a --- /dev/null +++ b/docs/sphinx/source/blocks/index.rst @@ -0,0 +1,344 @@ +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 + gnuradio.blocks.ctrlport_probe_c + gnuradio.blocks.message_debug + gnuradio.blocks.probe_rate + gnuradio.blocks.tag_debug + +Message Tools +------------- + +.. 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.pdu_to_tagged_stream + gnuradio.blocks.random_pdu + 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 + +Netwroking 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 + +Streams 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 + gnuradio.blocks.tag_debug + gnuradio.blocks.tagged_file_sink + +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 + +Waveform Generators +------------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.vco_f + +Miscellaneous +------------- + +.. autosummary:: + :nosignatures: + + gnuradio.blocks.lfsr_15_1_0 + gnuradio.blocks.lfsr_32k
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/level_controllers_blk.rst b/docs/sphinx/source/blocks/level_controllers_blk.rst new file mode 100644 index 0000000000..4e0b209479 --- /dev/null +++ b/docs/sphinx/source/blocks/level_controllers_blk.rst @@ -0,0 +1,16 @@ +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 new file mode 100644 index 0000000000..59f868a187 --- /dev/null +++ b/docs/sphinx/source/blocks/math_operators_blk.rst @@ -0,0 +1,53 @@ +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 new file mode 100644 index 0000000000..0669042594 --- /dev/null +++ b/docs/sphinx/source/blocks/measurement_tools_blk.rst @@ -0,0 +1,18 @@ +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 new file mode 100644 index 0000000000..37b63ab444 --- /dev/null +++ b/docs/sphinx/source/blocks/message_tools_blk.rst @@ -0,0 +1,11 @@ +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 new file mode 100644 index 0000000000..7a39845556 --- /dev/null +++ b/docs/sphinx/source/blocks/misc_blk.rst @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000000..ad35ed8c7a --- /dev/null +++ b/docs/sphinx/source/blocks/modulators_blk.rst @@ -0,0 +1,4 @@ +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 new file mode 100644 index 0000000000..d733b5d3e5 --- /dev/null +++ b/docs/sphinx/source/blocks/networking_tools_blk.rst @@ -0,0 +1,7 @@ +gnuradio.blocks: Netwroking Tools +================================= + +.. autoblock:: gnuradio.blocks.socket_pdu +.. autoblock:: gnuradio.blocks.tuntap_pdu +.. autoblock:: gnuradio.blocks.udp_sink +.. autoblock:: gnuradio.blocks.udp_source
\ No newline at end of file diff --git a/docs/sphinx/source/blocks/peak_detectors_blk.rst b/docs/sphinx/source/blocks/peak_detectors_blk.rst new file mode 100644 index 0000000000..1dee645d0a --- /dev/null +++ b/docs/sphinx/source/blocks/peak_detectors_blk.rst @@ -0,0 +1,9 @@ +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 new file mode 100644 index 0000000000..9c470f3806 --- /dev/null +++ b/docs/sphinx/source/blocks/stream_operators_blk.rst @@ -0,0 +1,26 @@ +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 new file mode 100644 index 0000000000..1eab0eae2f --- /dev/null +++ b/docs/sphinx/source/blocks/stream_tag_tools_blk.rst @@ -0,0 +1,6 @@ +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 new file mode 100644 index 0000000000..56567c89e9 --- /dev/null +++ b/docs/sphinx/source/blocks/type_converters_blk.rst @@ -0,0 +1,22 @@ +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 new file mode 100644 index 0000000000..b3edeeb936 --- /dev/null +++ b/docs/sphinx/source/blocks/waveform_generators_blk.rst @@ -0,0 +1,4 @@ +gnuradio.blocks: Waveform Generators +==================================== + +.. autoblock:: gnuradio.blocks.vco_f
\ No newline at end of file diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index f91252d17a..be8cc27b95 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -10,6 +10,7 @@ Core Framework :nosignatures: gnuradio.gr + gnuradio.blocks gnuradio.digital gnuradio.audio gnuradio.trellis @@ -23,6 +24,7 @@ Core Framework :hidden: gnuradio.gr <gr/index> + gnuradio.blocks <blocks/index> gnuradio.digital <digital/index> gnuradio.audio <audio/index> gnuradio.gr_unittest <gr_unittest/index> @@ -106,3 +108,21 @@ Framework Extensions 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> |