diff options
author | Tom Rondeau <tom@trondeau.com> | 2015-08-17 13:02:35 -0400 |
---|---|---|
committer | Tom Rondeau <tom@trondeau.com> | 2015-08-17 14:37:25 -0400 |
commit | c0d72bb7eed0aafc82762db7cd9a498eadf8b2b9 (patch) | |
tree | 85828bd9415b6bb4334f34d0d51cc68a36064d2a /docs/sphinx/source/analog/index.rst | |
parent | dff90672879bf1ed9d3e083ba236fdd6ce29e168 (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/index.rst')
-rw-r--r-- | docs/sphinx/source/analog/index.rst | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/sphinx/source/analog/index.rst b/docs/sphinx/source/analog/index.rst deleted file mode 100644 index 668247cab3..0000000000 --- a/docs/sphinx/source/analog/index.rst +++ /dev/null @@ -1,61 +0,0 @@ -gnuradio.analog -=============== - -.. automodule:: gnuradio.analog - -Level Controllers ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.analog.agc_cc - gnuradio.analog.agc2_cc - gnuradio.analog.agc2_ff - gnuradio.analog.agc_ff - gnuradio.analog.ctcss_squelch_ff - gnuradio.analog.feedforward_agc_cc - gnuradio.analog.pwr_squelch_cc - gnuradio.analog.pwr_squelch_ff - gnuradio.analog.rail_ff - gnuradio.analog.simple_squelch_cc - -Measurement Tools ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.analog.probe_avg_mag_sqrd_c - gnuradio.analog.probe_avg_mag_sqrd_cf - gnuradio.analog.probe_avg_mag_sqrd_f - -Modulators and Demodulators ---------------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.cpfsk_bc - gnuradio.analog.fmdet_cf - gnuradio.analog.frequency_modulator_fc - gnuradio.analog.phase_modulator_fc - gnuradio.analog.quadrature_demod_cf - -Peak Detectors --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.dpll_bb - -Synchronizers -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.pll_carriertracking_cc - gnuradio.analog.pll_freqdet_cf - gnuradio.analog.pll_refout_cc |