diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-04-27 15:56:00 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-04-27 15:56:00 -0700 |
| commit | 72948e9a4031f8d779a70f73e6e6a0014d1de326 (patch) | |
| tree | ef8ea31b6d053fa73db56c8f50f4d9bbadb78d53 | |
| parent | 7ffda05db5aeb0bdd590a10b6d340fa49192b7fd (diff) | |
sphinx: Add start of pmt sphinx docs. Tidied gr sphinx docs.
| -rw-r--r-- | docs/sphinx/source/blocks/index.rst | 8 | ||||
| -rw-r--r-- | docs/sphinx/source/gr/contents.rst (renamed from docs/sphinx/source/gr/misc.rst) | 19 | ||||
| -rw-r--r-- | docs/sphinx/source/gr/index.rst | 36 | ||||
| -rw-r--r-- | docs/sphinx/source/gr/internal.rst | 7 | ||||
| -rw-r--r-- | docs/sphinx/source/gr/top_block.rst | 7 | ||||
| -rw-r--r-- | docs/sphinx/source/index.rst | 6 | ||||
| -rw-r--r-- | docs/sphinx/source/pmt/index.rst | 232 |
7 files changed, 256 insertions, 59 deletions
diff --git a/docs/sphinx/source/blocks/index.rst b/docs/sphinx/source/blocks/index.rst index 2e29a5012a..751092b8b6 100644 --- a/docs/sphinx/source/blocks/index.rst +++ b/docs/sphinx/source/blocks/index.rst @@ -334,11 +334,3 @@ Waveform Generators gnuradio.blocks.vco_f -Miscellaneous -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.lfsr_15_1_0 - gnuradio.blocks.lfsr_32k
\ No newline at end of file diff --git a/docs/sphinx/source/gr/misc.rst b/docs/sphinx/source/gr/contents.rst index 013f3fc53d..a999a73ea8 100644 --- a/docs/sphinx/source/gr/misc.rst +++ b/docs/sphinx/source/gr/contents.rst @@ -1,11 +1,18 @@ -gnuradio.gr: Miscellaneous -========================== +gnuradio.gr +=========== -.. autofunction:: gnuradio.gr.feval_dd -.. autofunction:: gnuradio.gr.feval_cc -.. autofunction:: gnuradio.gr.feval_ll -.. autofunction:: gnuradio.gr.feval +.. 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 index cef9d560e2..7df7114340 100644 --- a/docs/sphinx/source/gr/index.rst +++ b/docs/sphinx/source/gr/index.rst @@ -3,41 +3,21 @@ gnuradio.gr .. automodule:: gnuradio.gr -Signal Processing Blocks ------------------------- - -Top Block and Hierarchical Block Base Classes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. autosummary:: :nosignatures: gnuradio.gr.top_block gnuradio.gr.hier_block2 - -Miscellaneous -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.gr.feval_dd - gnuradio.gr.feval_cc - gnuradio.gr.feval_ll - gnuradio.gr.feval - gnuradio.gr.prefs - gnuradio.gr.message - gnuradio.gr.msg_queue - gnuradio.gr.enable_realtime_scheduling - -Implementation Details ----------------------- - -.. autosummary:: - :nosignatures: - 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 diff --git a/docs/sphinx/source/gr/internal.rst b/docs/sphinx/source/gr/internal.rst deleted file mode 100644 index 4948b38d4d..0000000000 --- a/docs/sphinx/source/gr/internal.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Implementation Details -=================================== - -.. autofunction:: gnuradio.gr.block_detail -.. autofunction:: gnuradio.gr.buffer -.. autofunction:: gnuradio.gr.dispatcher -.. autofunction:: gnuradio.gr.single_threaded_scheduler diff --git a/docs/sphinx/source/gr/top_block.rst b/docs/sphinx/source/gr/top_block.rst deleted file mode 100644 index 3d4e9ef3d6..0000000000 --- a/docs/sphinx/source/gr/top_block.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.gr: Top Block and Hierarchical Block Base Classes -========================================================== - -.. autoclass:: gnuradio.gr.top_block - -.. autoclass:: gnuradio.gr.hier_block2 - diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index a79d3f2088..a4cd3dd7c6 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -10,6 +10,7 @@ Core Framework :nosignatures: gnuradio.gr + pmt gnuradio.blocks gnuradio.analog gnuradio.digital @@ -29,6 +30,7 @@ Core Framework :hidden: gnuradio.gr <gr/index> + pmt <pmt> gnuradio.blocks <blocks/index> gnuradio.analog <analog/index> gnuradio.digital <digital/index> @@ -106,9 +108,7 @@ Framework Extensions .. toctree:: :hidden: - internal <gr/internal> - top_block <gr/top_block> - misc <gr/misc> + runtime_contents <gr/contents> atsc_blks <atsc/blks> digital_blocks <digital/blocks> constellations <digital/constellations> diff --git a/docs/sphinx/source/pmt/index.rst b/docs/sphinx/source/pmt/index.rst new file mode 100644 index 0000000000..2411f626e4 --- /dev/null +++ b/docs/sphinx/source/pmt/index.rst @@ -0,0 +1,232 @@ +pmt +=== + +.. automodule:: pmt + +Contants +-------- + +.. autosummary:: + :nosignatures: + + pmt.PMT_EOF + pmt.PMT_EOF + pmt.PMT_F + pmt.PMT_NIL + pmt.PMT_T + +Vector +------ + +.. autosummary:: + :nosignatures: + + pmt.c32vector_elements + pmt.c64vector_elements + pmt.f32vector_elements + pmt.f64vector_elements + pmt.s16vector_elements + pmt.s32vector_elements + pmt.s8vector_elements + pmt.u16vector_elements + pmt.u32vector_elements + pmt.u8vector_elements + pmt.uniform_vector_elements + + pmt.c32vector_ref + pmt.c64vector_ref + pmt.f32vector_ref + pmt.f64vector_ref + pmt.s16vector_ref + pmt.s32vector_ref + pmt.s64vector_ref + pmt.s8vector_ref + pmt.u16vector_ref + pmt.u32vector_ref + pmt.u64vector_ref + pmt.u8vector_ref + pmt.vector_ref + + pmt.c32vector_set + pmt.c64vector_set + pmt.f32vector_set + pmt.f64vector_set + pmt.s16vector_set + pmt.s32vector_set + pmt.s64vector_set + pmt.s8vector_set + pmt.u16vector_set + pmt.u32vector_set + pmt.u64vector_set + pmt.u8vector_set + pmt.vector_set + + pmt.gr_vector_complexd + pmt.gr_vector_complexf + pmt.gr_vector_vector_complexd + pmt.gr_vector_vector_complexf + + pmt.init_c32vector + pmt.init_c64vector + pmt.init_f32vector + pmt.init_f64vector + pmt.init_s16vector + pmt.init_s32vector + pmt.init_s8vector + pmt.init_u16vector + pmt.init_u32vector + pmt.init_u8vector + + pmt.make_c32vector + pmt.make_c64vector + pmt.make_f32vector + pmt.make_f64vector + pmt.make_s16vector + pmt.make_s32vector + pmt.make_s64vector + pmt.make_s8vector + pmt.make_u16vector + pmt.make_u32vector + pmt.make_u64vector + pmt.make_u8vector + pmt.make_vector + + pmt.vector_fill + +Dictionary +---------- + +.. autosummary:: + :nosignatures: + + pmt.dict_add + pmt.dict_delete + pmt.dict_has_key + pmt.dict_items + pmt.dict_keys + pmt.dict_ref + pmt.dict_values + pmt.make_dict + +Unused +------ + +.. autosummary:: + :nosignatures: + + pmt.acons + pmt.any_ref + pmt.any_set + pmt_assoc + pmt.assq + pmt.assv + pmt.blob_data + pmt.blob_length + pmt.caar + pmt.cadddr + pmt.caddr + pmt.cadr + pmt.car + pmt.cdar + pmt.cddr + pmt.cdr + pmt.cons + pmt.cvar + pmt.deserialize + pmt.deserialize_str + pmt.dump_sizeof + pmt.eq + pmt.equal + pmt.eqv + pmt.from_bool + pmt.from_complex + pmt.from_double + pmt.from_long + pmt.from_uint64 + pmt.intern + pmt.list1 + pmt.list2 + pmt.list3 + pmt.list4 + pmt.list5 + pmt.list6 + pmt.list_add + pmt.list_has + pmt.list_rm + pmt.make_any + pmt.make_blob + pmt.make_msg_accepter + pmt.make_rectangular + pmt.make_tuple + pmt.map + pmt.member + pmt.memq + pmt.memv + pmt.msg_accepter_ref + pmt.nth + pmt.nthcdr + pmt.pmt_swig + pmt.pmt_to_python + pmt.read + pmt.reverse + pmt.reverse_x + pmt.serialize + pmt.serialize_str + pmt.set_car + pmt.set_cdr + pmt.string_to_symbol + pmt.subsetp + pmt.swig_int_ptr + pmt.swig_int_ptr_swigregister + pmt.symbol_to_string + pmt.to_bool + pmt.to_complex + pmt.to_double + pmt.to_long + pmt.to_pmt + pmt.to_python + pmt.to_tuple + pmt.to_uint64 + pmt.tuple_ref + pmt.write + pmt.write_string + +Check PMT Type +-------------- + +.. autosummary:: + :nosignatures: + + pmt.is_any + pmt.is_blob + pmt.is_bool + pmt.is_c32vector + pmt.is_c64vector + pmt.is_complex + pmt.is_dict + pmt.is_eof_object + pmt.is_f32vector + pmt.is_f64vector + pmt.is_false + pmt.is_integer + pmt.is_msg_accepter + pmt.is_null + pmt.is_number + pmt.is_pair + pmt.is_real + pmt.is_s16vector + pmt.is_s32vector + pmt.is_s64vector + pmt.is_s8vector + pmt.is_symbol + pmt.is_true + pmt.is_tuple + pmt.is_u16vector + pmt.is_u32vector + pmt.is_u64vector + pmt.is_u8vector + pmt.is_uint64 + pmt.is_uniform_vector + pmt.is_vector + pmt.length + |