summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/index.rst
blob: 887271ce00489f171cb51f2036738efe32b187fb (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
gnuradio
========

.. automodule:: gnuradio

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

.. autosummary::
   :nosignatures:

   gnuradio.gr
   gnuradio.digital
   gnuradio.blks2
   gnuradio.audio
   gnuradio.trellis
   gnuradio.wavelet
   gnuradio.window
   gnuradio.optfir
   gnuradio.gr_unittest
   gnuradio.qtgui
   gnuradio.wxgui

.. toctree::
   :hidden:   

   gnuradio.gr <gr/index>
   gnuradio.digital <digital/index>
   gnuradio.blks2 <blks2/index>
   gnuradio.audio <audio/index>
   gnuradio.gr_unittest <gr_unittest/index>
   gnuradio.optfir <optfir/index>
   gnuradio.trellis <trellis/index>
   gnuradio.wavelet <wavelet>
   gnuradio.window <window/index>
   gnuradio.qtgui <qtgui/index>
   gnuradio.wxgui <wxgui/index>

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:   
   
   coding <gr/coding_blk>
   converter <gr/converter_blk>
   demodulation <gr/demodulation_blk>
   dft <gr/dft_blk>
   filter <gr/filter_blk>
   filter_design <gr/filter_design>
   internal <gr/internal>
   level <gr/level_blk>
   math <gr/math_blk>
   misc <gr/misc>
   misc <gr/misc_blk>
   modulation <gr/modulation_blk>
   sink <gr/sink_blk>
   slicedice <gr/slicedice_blk>
   source <gr/source_blk>
   sync <gr/sync_blk>
   top_block <gr/top_block>

   atsc_blks <atsc/blks>
   blks <blks2/blks>
   blks2_utilities <blks2/utilities>
   digital_blocks <digital/blocks>
   constellations <digital/constellations>
   ofdm <digital/ofdm>
   pkt_utils <digital/pkt_utils>
   digital_utilities <digital/utilities>
   optfir <optfir/detail>
   pager_blks <pager/blks>
   pyqt_filter <pyqt_filter>
   pyqt_plot <pyqt_plot>
   trellis_blks <trellis/blks>
   trellis_objs <trellis/objs>
   vocoder_blks <vocoder/blks>
   window_detail <window/detail>
   wxgui_blks <wxgui/blks>