summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/runtime.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/runtime.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/runtime.rst')
-rw-r--r--docs/sphinx/source/runtime.rst65
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/sphinx/source/runtime.rst b/docs/sphinx/source/runtime.rst
new file mode 100644
index 0000000000..b94dd90d5e
--- /dev/null
+++ b/docs/sphinx/source/runtime.rst
@@ -0,0 +1,65 @@
+gnuradio.gr
+===========
+
+.. autoclass:: gnuradio.gr.top_block
+
+.. autoclass:: gnuradio.gr.basic_block
+.. autoclass:: gnuradio.gr.block
+.. autoclass:: gnuradio.gr.sync_block
+.. autoclass:: gnuradio.gr.sync_decimator
+.. autoclass:: gnuradio.gr.sync_interpolator
+.. autoclass:: gnuradio.gr.tagged_stream_block
+.. autoclass:: gnuradio.gr.hier_block2
+
+.. autofunction:: gnuradio.gr.high_res_timer_now
+.. autofunction:: gnuradio.gr.high_res_timer_now_perfmon
+.. autofunction:: gnuradio.gr.high_res_timer_epoch
+.. autofunction:: gnuradio.gr.high_res_timer_tps
+
+.. autoclass:: gnuradio.gr.io_signature
+.. autoclass:: gnuradio.gr.io_signature2
+.. autoclass:: gnuradio.gr.io_signature3
+.. autoclass:: gnuradio.gr.io_signaturev
+
+.. autofunction:: gnuradio.gr.prefix
+.. autofunction:: gnuradio.gr.prefsdir
+.. autofunction:: gnuradio.gr.sysconfdir
+.. autofunction:: gnuradio.gr.version
+.. autofunction:: gnuradio.gr.major_version
+.. autofunction:: gnuradio.gr.api_version
+.. autofunction:: gnuradio.gr.minor_version
+.. autoclass:: gnuradio.gr.prefs
+.. autoclass:: gnuradio.gr.logger
+.. autofunction:: gnuradio.gr.logger_config
+.. autofunction:: gnuradio.gr.logger_get_names
+.. autofunction:: gnuradio.gr.logger_reset_config
+
+.. autoclass:: gnuradio.gr.tag_t
+.. autofunction:: gnuradio.gr.tag_t_offset_compare
+.. autofunction:: gnuradio.gr.tag_t_offset_compare_key
+.. autofunction:: gnuradio.gr.tag_to_pmt
+.. autofunction:: gnuradio.gr.tag_to_python
+.. autoclass:: gnuradio.gr.tag_utils
+
+.. autoclass:: gnuradio.gr.sizeof_gr_complex
+.. autoclass:: gnuradio.gr.sizeof_float
+.. autoclass:: gnuradio.gr.sizeof_int
+.. autoclass:: gnuradio.gr.sizeof_short
+.. autoclass:: gnuradio.gr.sizeof_char
+.. autoclass:: gnuradio.gr.sizeof_double
+
+.. autofunction:: gnuradio.gr.branchless_binary_slicer
+.. autofunction:: gnuradio.gr.binary_slicer
+.. autofunction:: gnuradio.gr.branchless_clip
+.. autofunction:: gnuradio.gr.clip
+.. autofunction:: gnuradio.gr.branchless_quad_0deg_slicer
+.. autofunction:: gnuradio.gr.quad_0deg_slicer
+.. autofunction:: gnuradio.gr.branchless_quad_45deg_slicer
+.. autofunction:: gnuradio.gr.quad_45deg_slicer
+
+.. autoclass:: gnuradio.gr.feval
+.. autoclass:: gnuradio.gr.feval_cc
+.. autoclass:: gnuradio.gr.feval_dd
+.. autoclass:: gnuradio.gr.feval_ll
+.. autoclass:: gnuradio.gr.feval_p
+.. autoclass:: gnuradio.gr.gateway