Skip to content

Commit c0d72bb

Browse files
committed
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.
1 parent dff9067 commit c0d72bb

File tree

106 files changed

+2463
-2435
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+2463
-2435
lines changed

docs/sphinx/source/analog.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
gnuradio.analog
2+
===============
3+
4+
.. autoclass:: gnuradio.analog.cpm
5+
.. autoclass:: gnuradio.analog.squelch_base_cc
6+
.. autoclass:: gnuradio.analog.squelch_base_ff
7+
.. autoclass:: gnuradio.analog.am_demod_cf
8+
.. autoclass:: gnuradio.analog.demod_10k0a3e_cf
9+
.. autoclass:: gnuradio.analog.fm_demod_cf
10+
.. autoclass:: gnuradio.analog.demod_20k0f3e_cf
11+
.. autoclass:: gnuradio.analog.demod_200kf3e_cf
12+
.. autoclass:: gnuradio.analog.fm_deemph
13+
.. autoclass:: gnuradio.analog.fm_preemph
14+
.. autoclass:: gnuradio.analog.nbfm_rx
15+
.. autoclass:: gnuradio.analog.nbfm_tx
16+
.. autoclass:: gnuradio.analog.ctcss_gen_f
17+
.. autoclass:: gnuradio.analog.standard_squelch
18+
.. autoclass:: gnuradio.analog.wfm_rcv_fmdet
19+
.. autoclass:: gnuradio.analog.wfm_rcv_pll
20+
.. autoclass:: gnuradio.analog.wfm_rcv
21+
.. autoclass:: gnuradio.analog.wfm_tx

docs/sphinx/source/analog/get_blocks.py

-106
This file was deleted.

docs/sphinx/source/analog/index.rst

-61
This file was deleted.

docs/sphinx/source/analog/level_controllers_blk.rst

-13
This file was deleted.

docs/sphinx/source/analog/measurement_tools_blk.rst

-6
This file was deleted.

docs/sphinx/source/analog/modulators_blk.rst

-8
This file was deleted.

docs/sphinx/source/analog/peak_detectors_blk.rst

-4
This file was deleted.

docs/sphinx/source/analog/synchronizers_blk.rst

-6
This file was deleted.

docs/sphinx/source/analog_blocks.rst

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
gnuradio.analog
2+
===============
3+
4+
.. automodule:: gnuradio.analog
5+
6+
.. autoblock:: gnuradio.analog.agc2_cc
7+
.. autoblock:: gnuradio.analog.agc2_ff
8+
.. autoblock:: gnuradio.analog.agc3_cc
9+
.. autoblock:: gnuradio.analog.agc_cc
10+
.. autoblock:: gnuradio.analog.agc_ff
11+
.. autoblock:: gnuradio.analog.cpfsk_bc
12+
.. autoblock:: gnuradio.analog.ctcss_squelch_ff
13+
.. autoblock:: gnuradio.analog.dpll_bb
14+
.. autoblock:: gnuradio.analog.fastnoise_source_c
15+
.. autoblock:: gnuradio.analog.fastnoise_source_f
16+
.. autoblock:: gnuradio.analog.fastnoise_source_i
17+
.. autoblock:: gnuradio.analog.fastnoise_source_s
18+
.. autoblock:: gnuradio.analog.feedforward_agc_cc
19+
.. autoblock:: gnuradio.analog.fmdet_cf
20+
.. autoblock:: gnuradio.analog.frequency_modulator_fc
21+
.. autoblock:: gnuradio.analog.noise_source_c
22+
.. autoblock:: gnuradio.analog.noise_source_f
23+
.. autoblock:: gnuradio.analog.noise_source_i
24+
.. autoblock:: gnuradio.analog.noise_source_s
25+
.. autoblock:: gnuradio.analog.phase_modulator_fc
26+
.. autoblock:: gnuradio.analog.pll_carriertracking_cc
27+
.. autoblock:: gnuradio.analog.pll_freqdet_cf
28+
.. autoblock:: gnuradio.analog.pll_refout_cc
29+
.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_c
30+
.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_cf
31+
.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_f
32+
.. autoblock:: gnuradio.analog.pwr_squelch_cc
33+
.. autoblock:: gnuradio.analog.pwr_squelch_ff
34+
.. autoblock:: gnuradio.analog.quadrature_demod_cf
35+
.. autoblock:: gnuradio.analog.rail_ff
36+
.. autoblock:: gnuradio.analog.sig_source_c
37+
.. autoblock:: gnuradio.analog.sig_source_f
38+
.. autoblock:: gnuradio.analog.sig_source_i
39+
.. autoblock:: gnuradio.analog.sig_source_s
40+
.. autoblock:: gnuradio.analog.simple_squelch_cc

docs/sphinx/source/atsc/blks.rst

-20
This file was deleted.

docs/sphinx/source/atsc/index.rst

-62
This file was deleted.
File renamed without changes.

docs/sphinx/source/blocks/audio_blk.rst

-5
This file was deleted.

docs/sphinx/source/blocks/boolean_operators_blk.rst

-18
This file was deleted.

0 commit comments

Comments
 (0)