diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-05-19 01:32:36 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-05-19 01:32:36 -0700 |
| commit | 0fa219774dcf9141ae91204f948c029b05673f3f (patch) | |
| tree | 32a12974c9bd34edb895b8d33df47bf9db959001 /docs | |
| parent | b1f802015fe5ce88c45f68f09d81fce0cdb75411 (diff) | |
| parent | 318da62b6104e4bca182d94aec4abc0618debffd (diff) | |
Merge with next branch.
Diffstat (limited to 'docs')
44 files changed, 1354 insertions, 55 deletions
diff --git a/docs/doxygen/doxyxml/doxyindex.py b/docs/doxygen/doxyxml/doxyindex.py index 8c5502a61f..69c6de07f5 100644 --- a/docs/doxygen/doxyxml/doxyindex.py +++ b/docs/doxygen/doxyxml/doxyindex.py @@ -43,13 +43,16 @@ class DoxyIndex(Base): self._root = index.parse(os.path.join(self._xml_path, 'index.xml')) for mem in self._root.compound: converted = self.convert_mem(mem) - # For files we want the contents to be accessible directly - # from the parent rather than having to go through the file - # object. + # For files and namespaces we want the contents to be + # accessible directly from the parent rather than having + # to go through the file object. if self.get_cls(mem) == DoxyFile: if mem.name.endswith('.h'): self._members += converted.members() self._members.append(converted) + elif self.get_cls(mem) == DoxyNamespace: + self._members += converted.members() + self._members.append(converted) else: self._members.append(converted) @@ -227,7 +230,17 @@ class DoxyNamespace(DoxyCompound): __module__ = "gnuradio.utils.doxyxml" kind = 'namespace' - + + def _parse(self): + if self._parsed: + return + super(DoxyNamespace, self)._parse() + self.retrieve_data() + self.set_descriptions(self._retrieved_data.compounddef) + if self._error: + return + self.process_memberdefs() + Base.mem_classes.append(DoxyNamespace) diff --git a/docs/sphinx/source/analog/get_blocks.py b/docs/sphinx/source/analog/get_blocks.py new file mode 100644 index 0000000000..a288393132 --- /dev/null +++ b/docs/sphinx/source/analog/get_blocks.py @@ -0,0 +1,106 @@ +""" +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 new file mode 100644 index 0000000000..668247cab3 --- /dev/null +++ b/docs/sphinx/source/analog/index.rst @@ -0,0 +1,61 @@ +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 new file mode 100644 index 0000000000..738535d207 --- /dev/null +++ b/docs/sphinx/source/analog/level_controllers_blk.rst @@ -0,0 +1,13 @@ +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 new file mode 100644 index 0000000000..be9accc7e5 --- /dev/null +++ b/docs/sphinx/source/analog/measurement_tools_blk.rst @@ -0,0 +1,6 @@ +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 new file mode 100644 index 0000000000..3e9f279271 --- /dev/null +++ b/docs/sphinx/source/analog/modulators_blk.rst @@ -0,0 +1,8 @@ +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 new file mode 100644 index 0000000000..3105202c2a --- /dev/null +++ b/docs/sphinx/source/analog/peak_detectors_blk.rst @@ -0,0 +1,4 @@ +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 new file mode 100644 index 0000000000..938b24ad61 --- /dev/null +++ b/docs/sphinx/source/analog/synchronizers_blk.rst @@ -0,0 +1,6 @@ +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/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..f89c9c5df5 --- /dev/null +++ b/docs/sphinx/source/blocks/index.rst @@ -0,0 +1,337 @@ +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 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/channels.rst b/docs/sphinx/source/channels.rst new file mode 100644 index 0000000000..4013b57938 --- /dev/null +++ b/docs/sphinx/source/channels.rst @@ -0,0 +1,8 @@ +gnuradio.channels +================= + +.. automodule:: gnuradio.channels + +.. autoblock:: gnuradio.channels.channel_model +.. autoblock:: gnuradio.channels.fading_model + diff --git a/docs/sphinx/source/comedi.rst b/docs/sphinx/source/comedi.rst new file mode 100644 index 0000000000..2bed3683a2 --- /dev/null +++ b/docs/sphinx/source/comedi.rst @@ -0,0 +1,8 @@ +gnuradio.comedi +=============== + +.. automodule:: gnuradio.comedi + +.. autoblock:: gnuradio.comedi.source_s +.. autoblock:: gnuradio.comedi.sink_s + diff --git a/docs/sphinx/source/fcd.rst b/docs/sphinx/source/fcd.rst new file mode 100644 index 0000000000..126ef9c916 --- /dev/null +++ b/docs/sphinx/source/fcd.rst @@ -0,0 +1,7 @@ +gnuradio.fcd +============ + +.. automodule:: gnuradio.fcd + +.. autoblock:: gnuradio.fcd.fcd_source_c + diff --git a/docs/sphinx/source/fec.rst b/docs/sphinx/source/fec.rst new file mode 100644 index 0000000000..75de71911b --- /dev/null +++ b/docs/sphinx/source/fec.rst @@ -0,0 +1,8 @@ +gnuradio.fec +============ + +.. automodule:: gnuradio.fec + +.. autoblock:: gnuradio.fec.decode_ccsds_27_fb +.. autoblock:: gnuradio.fec.encode_ccsds_27_bb + diff --git a/docs/sphinx/source/filter/channelizers_blk.rst b/docs/sphinx/source/filter/channelizers_blk.rst new file mode 100644 index 0000000000..920be42882 --- /dev/null +++ b/docs/sphinx/source/filter/channelizers_blk.rst @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000..5c85c6d00a --- /dev/null +++ b/docs/sphinx/source/filter/filter_blk.rst @@ -0,0 +1,16 @@ +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 new file mode 100644 index 0000000000..4a78156c5d --- /dev/null +++ b/docs/sphinx/source/filter/filter_design.rst @@ -0,0 +1,4 @@ +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 new file mode 100644 index 0000000000..2f1be277ad --- /dev/null +++ b/docs/sphinx/source/filter/index.rst @@ -0,0 +1,56 @@ +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 new file mode 100644 index 0000000000..348888659d --- /dev/null +++ b/docs/sphinx/source/filter/resamplers_blk.rst @@ -0,0 +1,9 @@ +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/gr/misc.rst b/docs/sphinx/source/gr/contents.rst index 013f3fc53d..a999a73ea8 100644 --- a/docs/sphinx/source/gr/misc.rst +++ b/docs/sphinx/source/gr/contents.rst @@ -1,11 +1,18 @@ -gnuradio.gr: Miscellaneous -========================== +gnuradio.gr +=========== -.. autofunction:: gnuradio.gr.feval_dd -.. autofunction:: gnuradio.gr.feval_cc -.. autofunction:: gnuradio.gr.feval_ll -.. autofunction:: gnuradio.gr.feval +.. 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 index cef9d560e2..7df7114340 100644 --- a/docs/sphinx/source/gr/index.rst +++ b/docs/sphinx/source/gr/index.rst @@ -3,41 +3,21 @@ gnuradio.gr .. automodule:: gnuradio.gr -Signal Processing Blocks ------------------------- - -Top Block and Hierarchical Block Base Classes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. autosummary:: :nosignatures: gnuradio.gr.top_block gnuradio.gr.hier_block2 - -Miscellaneous -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.gr.feval_dd - gnuradio.gr.feval_cc - gnuradio.gr.feval_ll - gnuradio.gr.feval - gnuradio.gr.prefs - gnuradio.gr.message - gnuradio.gr.msg_queue - gnuradio.gr.enable_realtime_scheduling - -Implementation Details ----------------------- - -.. autosummary:: - :nosignatures: - 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/internal.rst b/docs/sphinx/source/gr/internal.rst deleted file mode 100644 index 4948b38d4d..0000000000 --- a/docs/sphinx/source/gr/internal.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Implementation Details -=================================== - -.. autofunction:: gnuradio.gr.block_detail -.. autofunction:: gnuradio.gr.buffer -.. autofunction:: gnuradio.gr.dispatcher -.. autofunction:: gnuradio.gr.single_threaded_scheduler diff --git a/docs/sphinx/source/gr/top_block.rst b/docs/sphinx/source/gr/top_block.rst deleted file mode 100644 index 3d4e9ef3d6..0000000000 --- a/docs/sphinx/source/gr/top_block.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Top Block and Hierarchical Block Base Classes -========================================================== - -.. autoclass:: gnuradio.gr.top_block - -.. autoclass:: gnuradio.gr.hier_block2 - diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index f91252d17a..ceafe7e80e 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -10,8 +10,15 @@ Core Framework :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 @@ -23,8 +30,15 @@ Core Framework :hidden: 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> @@ -39,11 +53,15 @@ Hardware Interfaces :nosignatures: gnuradio.uhd + gnuradio.fcd + gnuradio.shd .. toctree:: :hidden: gnuradio.uhd <uhd> + gnuradio.fcd <fcd> + gnuradio.shd <shd> Utilities --------- @@ -90,9 +108,7 @@ Framework Extensions .. toctree:: :hidden: - internal <gr/internal> - top_block <gr/top_block> - misc <gr/misc> + runtime_contents <gr/contents> atsc_blks <atsc/blks> digital_blocks <digital/blocks> constellations <digital/constellations> @@ -106,3 +122,31 @@ 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> + 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> + diff --git a/docs/sphinx/source/pmt/index.rst b/docs/sphinx/source/pmt/index.rst new file mode 100644 index 0000000000..2411f626e4 --- /dev/null +++ b/docs/sphinx/source/pmt/index.rst @@ -0,0 +1,232 @@ +pmt +=== + +.. automodule:: pmt + +Contants +-------- + +.. autosummary:: + :nosignatures: + + pmt.PMT_EOF + pmt.PMT_EOF + pmt.PMT_F + pmt.PMT_NIL + pmt.PMT_T + +Vector +------ + +.. autosummary:: + :nosignatures: + + 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 + pmt.uniform_vector_elements + + 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.vector_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.vector_set + + pmt.gr_vector_complexd + pmt.gr_vector_complexf + pmt.gr_vector_vector_complexd + pmt.gr_vector_vector_complexf + + 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.make_c32vector + pmt.make_c64vector + pmt.make_f32vector + pmt.make_f64vector + pmt.make_s16vector + pmt.make_s32vector + pmt.make_s64vector + pmt.make_s8vector + pmt.make_u16vector + pmt.make_u32vector + pmt.make_u64vector + pmt.make_u8vector + pmt.make_vector + + pmt.vector_fill + +Dictionary +---------- + +.. autosummary:: + :nosignatures: + + pmt.dict_add + pmt.dict_delete + pmt.dict_has_key + pmt.dict_items + pmt.dict_keys + pmt.dict_ref + pmt.dict_values + pmt.make_dict + +Unused +------ + +.. autosummary:: + :nosignatures: + + pmt.acons + pmt.any_ref + pmt.any_set + pmt_assoc + pmt.assq + pmt.assv + pmt.blob_data + pmt.blob_length + pmt.caar + pmt.cadddr + pmt.caddr + pmt.cadr + pmt.car + pmt.cdar + pmt.cddr + pmt.cdr + pmt.cons + pmt.cvar + pmt.deserialize + pmt.deserialize_str + pmt.dump_sizeof + pmt.eq + pmt.equal + pmt.eqv + pmt.from_bool + pmt.from_complex + pmt.from_double + pmt.from_long + pmt.from_uint64 + pmt.intern + 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_msg_accepter + pmt.make_rectangular + pmt.make_tuple + pmt.map + pmt.member + pmt.memq + pmt.memv + pmt.msg_accepter_ref + pmt.nth + pmt.nthcdr + pmt.pmt_swig + pmt.pmt_to_python + pmt.read + pmt.reverse + pmt.reverse_x + pmt.serialize + pmt.serialize_str + pmt.set_car + pmt.set_cdr + pmt.string_to_symbol + pmt.subsetp + pmt.swig_int_ptr + pmt.swig_int_ptr_swigregister + pmt.symbol_to_string + pmt.to_bool + pmt.to_complex + pmt.to_double + pmt.to_long + pmt.to_pmt + pmt.to_python + pmt.to_tuple + pmt.to_uint64 + pmt.tuple_ref + pmt.write + pmt.write_string + +Check PMT Type +-------------- + +.. autosummary:: + :nosignatures: + + 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 + diff --git a/docs/sphinx/source/shd.rst b/docs/sphinx/source/shd.rst new file mode 100644 index 0000000000..6661ceb9b1 --- /dev/null +++ b/docs/sphinx/source/shd.rst @@ -0,0 +1,8 @@ +gnuradio.shd +============ + +.. automodule:: gnuradio.shd + +.. autoblock:: gnuradio.shd.shd_smini_sink +.. autoblock:: gnuradio.shd.shd_smini_source + |