summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/index.rst
blob: ceafe7e80eed0f500693d60b1b59601076f4788c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
gnuradio
========

.. automodule:: gnuradio

Core Framework
--------------

.. autosummary::
   :nosignatures:

   gnuradio.gr
   pmt
   gnuradio.blocks
   gnuradio.analog
   gnuradio.digital
   gnuradio.audio
   gnuradio.channels
   gnuradio.comedi
   gnuradio.fec
   gnuradio.filter
   gnuradio.trellis
   gnuradio.wavelet
   gnuradio.fft
   gnuradio.gr_unittest
   gnuradio.qtgui
   gnuradio.wxgui

.. toctree::
   :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>
   gnuradio.fft <fft>
   gnuradio.qtgui <qtgui/index>
   gnuradio.wxgui <wxgui/index>

Hardware Interfaces
-------------------

.. autosummary::
   :nosignatures:
   
   gnuradio.uhd
   gnuradio.fcd
   gnuradio.shd

.. toctree::
   :hidden:   

   gnuradio.uhd <uhd>
   gnuradio.fcd <fcd>
   gnuradio.shd <shd>

Utilities
---------

.. autosummary::
   :nosignatures:

   gnuradio.plot_data
   gnuradio.eng_notation
   gnuradio.eng_option

.. toctree::
   :hidden:   

   gnuradio.plot_data <plot_data>
   gnuradio.eng_notation <eng_notation/index>
   gnuradio.eng_option <eng_option/index>

Framework Extensions
--------------------

.. autosummary::
   :nosignatures:

   gnuradio.atsc
   gnuradio.noaa
   gnuradio.pager
   gnuradio.video_sdl
   gnuradio.vocoder

.. toctree::
   :hidden:   

   gnuradio.atsc <atsc/index>
   gnuradio.noaa <noaa>
   gnuradio.pager <pager/index>
   gnuradio.video_sdl <video_sdl>
   gnuradio.vocoder <vocoder/index>


.. Use this to add to the toctree but not displayed
.. It's mostly to get rid of warnings
 
.. toctree::
   :hidden:   
   
   runtime_contents <gr/contents>
   atsc_blks <atsc/blks>
   digital_blocks <digital/blocks>
   constellations <digital/constellations>
   ofdm <digital/ofdm>
   pkt_utils <digital/pkt_utils>
   digital_utilities <digital/utilities>
   pager_blks <pager/blks>
   pyqt_filter <pyqt_filter>
   pyqt_plot <pyqt_plot>
   trellis_blks <trellis/blks>
   trellis_objs <trellis/objs>
   vocoder_blks <vocoder/blks>
   wxgui_blks <wxgui/blks>
   blocks_modulators <blocks/modulators_blk>
   blocks_audio <blocks/audio_blk>
   blocks_networking <blocks/networking_tools_blk>
   blocks_boolean <blocks/boolean_operators_blk>
   blocks_peak_detectors <blocks/peak_detectors_blk>
   blocks_byte_operators <blocks/byte_operators_blk>
   blocks_level_controllers <blocks/level_controllers_blk>
   blocks_stream_operators <blocks/stream_operators_blk>
   blocks_controlport <blocks/controlport_blk>
   blocks_math <blocks/math_operators_blk>
   blocks_stream_tag <blocks/stream_tag_tools_blk>
   blocks_debug <blocks/debug_tools_blk>
   blocks_measurement <blocks/measurement_tools_blk>
   blocks_type_converters <blocks/type_converters_blk>
   blocks_file <blocks/file_operators_blk>
   blocks_message <blocks/message_tools_blk>
   blocks_waveform <blocks/waveform_generators_blk>
   blocks_misc <blocks/misc_blk>
   analog_level_controllers <analog/level_controllers_blk>
   analog_peak_detectors <analog/peak_detectors_blk>
   analog_measurement <analog/measurement_tools_blk>
   analog_synchronizers <analog/synchronizers_blk>
   analog_modulators <analog/modulators_blk>
   filter_channelizers <filter/channelizers_blk>
   filter_resamplers <filter/resamplers_blk>
   filter_blocks <filter/filter_blk>
   filter_design <filter/filter_design>