summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/analog_blocks.rst
diff options
context:
space:
mode:
authorTom Rondeau <tom@trondeau.com>2015-08-17 13:02:35 -0400
committerTom Rondeau <tom@trondeau.com>2015-08-17 14:37:25 -0400
commitc0d72bb7eed0aafc82762db7cd9a498eadf8b2b9 (patch)
tree85828bd9415b6bb4334f34d0d51cc68a36064d2a /docs/sphinx/source/analog_blocks.rst
parentdff90672879bf1ed9d3e083ba236fdd6ce29e168 (diff)
docs: Reviving Python manual.
I'd like to only produce a single manual, and the Sphinx docs take too much manual labor to keep up-to-date. Still, there is a lot of useful tools and classes only in Python that need to be exposed in a manual, so this is the quickest way to get there. This flattens the sphinx documentation structure so each component has a <component>_blocks.rst where the actual GNU Radio blocks are managed and a <component>.rst for any other non-block or Python-only code (hier_block2, functions, and classes). The new flattened file structure should make it easier to update, but the index.rst should have some work done to make structure information better.
Diffstat (limited to 'docs/sphinx/source/analog_blocks.rst')
-rw-r--r--docs/sphinx/source/analog_blocks.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/sphinx/source/analog_blocks.rst b/docs/sphinx/source/analog_blocks.rst
new file mode 100644
index 0000000000..bbf1a2275e
--- /dev/null
+++ b/docs/sphinx/source/analog_blocks.rst
@@ -0,0 +1,40 @@
+gnuradio.analog
+===============
+
+.. automodule:: gnuradio.analog
+
+.. autoblock:: gnuradio.analog.agc2_cc
+.. autoblock:: gnuradio.analog.agc2_ff
+.. autoblock:: gnuradio.analog.agc3_cc
+.. autoblock:: gnuradio.analog.agc_cc
+.. autoblock:: gnuradio.analog.agc_ff
+.. autoblock:: gnuradio.analog.cpfsk_bc
+.. autoblock:: gnuradio.analog.ctcss_squelch_ff
+.. autoblock:: gnuradio.analog.dpll_bb
+.. autoblock:: gnuradio.analog.fastnoise_source_c
+.. autoblock:: gnuradio.analog.fastnoise_source_f
+.. autoblock:: gnuradio.analog.fastnoise_source_i
+.. autoblock:: gnuradio.analog.fastnoise_source_s
+.. autoblock:: gnuradio.analog.feedforward_agc_cc
+.. autoblock:: gnuradio.analog.fmdet_cf
+.. autoblock:: gnuradio.analog.frequency_modulator_fc
+.. autoblock:: gnuradio.analog.noise_source_c
+.. autoblock:: gnuradio.analog.noise_source_f
+.. autoblock:: gnuradio.analog.noise_source_i
+.. autoblock:: gnuradio.analog.noise_source_s
+.. autoblock:: gnuradio.analog.phase_modulator_fc
+.. autoblock:: gnuradio.analog.pll_carriertracking_cc
+.. autoblock:: gnuradio.analog.pll_freqdet_cf
+.. autoblock:: gnuradio.analog.pll_refout_cc
+.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_c
+.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_cf
+.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_f
+.. autoblock:: gnuradio.analog.pwr_squelch_cc
+.. autoblock:: gnuradio.analog.pwr_squelch_ff
+.. autoblock:: gnuradio.analog.quadrature_demod_cf
+.. autoblock:: gnuradio.analog.rail_ff
+.. autoblock:: gnuradio.analog.sig_source_c
+.. autoblock:: gnuradio.analog.sig_source_f
+.. autoblock:: gnuradio.analog.sig_source_i
+.. autoblock:: gnuradio.analog.sig_source_s
+.. autoblock:: gnuradio.analog.simple_squelch_cc