summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/digital
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sphinx/source/digital')
-rw-r--r--docs/sphinx/source/digital/blocks.rst69
-rw-r--r--docs/sphinx/source/digital/constellations.rst13
-rw-r--r--docs/sphinx/source/digital/index.rst151
-rw-r--r--docs/sphinx/source/digital/ofdm.rst14
-rw-r--r--docs/sphinx/source/digital/pkt_utils.rst18
-rw-r--r--docs/sphinx/source/digital/utilities.rst12
6 files changed, 0 insertions, 277 deletions
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