summaryrefslogtreecommitdiff
path: root/docs/sphinx/source/gr
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/gr
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/gr')
-rw-r--r--docs/sphinx/source/gr/contents.rst18
-rw-r--r--docs/sphinx/source/gr/index.rst23
2 files changed, 0 insertions, 41 deletions
diff --git a/docs/sphinx/source/gr/contents.rst b/docs/sphinx/source/gr/contents.rst
deleted file mode 100644
index a999a73ea8..0000000000
--- a/docs/sphinx/source/gr/contents.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-gnuradio.gr
-===========
-
-.. autoclass:: gnuradio.gr.top_block
-.. autoclass:: gnuradio.gr.hier_block2
-.. autofunction:: gnuradio.gr.block_detail
-.. autofunction:: gnuradio.gr.buffer
-.. autofunction:: gnuradio.gr.dispatcher
-.. autofunction:: gnuradio.gr.single_threaded_scheduler
-.. autofunction:: gnuradio.gr.prefs
-.. autofunction:: gnuradio.gr.message
-.. autofunction:: gnuradio.gr.msg_queue
-.. autofunction:: gnuradio.gr.enable_realtime_scheduling
-.. autofunction:: gnuradio.gr.feval_dd
-.. autofunction:: gnuradio.gr.feval_cc
-.. autofunction:: gnuradio.gr.feval_ll
-.. autofunction:: gnuradio.gr.feval
-
diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst
deleted file mode 100644
index b3e341f47b..0000000000
--- a/docs/sphinx/source/gr/index.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-gnuradio.gr
-===========
-
-.. automodule:: gnuradio.gr
-
-.. autosummary::
- :nosignatures:
-
- gnuradio.gr.top_block
- gnuradio.gr.hier_block2
- gnuradio.gr.block_detail
- gnuradio.gr.buffer
- gnuradio.gr.dispatcher
- gnuradio.gr.single_threaded_scheduler
- gnuradio.gr.prefs
- gnuradio.gr.message
- gnuradio.gr.msg_queue
- gnuradio.gr.enable_realtime_scheduling
- gnuradio.gr.feval_dd
- gnuradio.gr.feval_cc
- gnuradio.gr.feval_ll
- gnuradio.gr.feval
-