README change

1 files changed, 133 insertions, 0 deletions

diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst
new file mode 100644
index 000000000..eafebc8d0
--- /dev/null
+++ b/docs/sphinx/source/index.rst
@@ -0,0 +1,133 @@
+gnuradio
+========
+
+.. automodule:: gnuradio
+
+Core Framework
+--------------
+
+.. autosummary::
+   :nosignatures:
+
+   gnuradio.gr
+   gnuradio.digital
+   gnuradio.blks2
+   gnuradio.audio
+   gnuradio.trellis
+   gnuradio.wavelet
+   gnuradio.fft
+   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.fft <fft>
+   gnuradio.window <window/index>
+   gnuradio.qtgui <qtgui/index>
+   gnuradio.wxgui <wxgui/index>
+
+Hardware Interfaces
+------------------
+
+.. autosummary::
+   :nosignatures:
+   
+   gnuradio.uhd
+
+.. toctree::
+   :hidden:   
+
+   gnuradio.uhd <uhd>
+
+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>