diff options
| author | Marc L <marcll@vt.edu> | 2019-06-21 23:20:03 -0400 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2020-01-02 15:41:05 -0800 |
| commit | 2dd057b54d20298bfc7cacdf090fc026b462ea7e (patch) | |
| tree | faec4b66abc61c06e185027a76f780a2b8ec918f /docs | |
| parent | 63171edab5742e2ce48e6e30d060a3719f8c1a4b (diff) | |
docs: Remove the sphinx manual
Going forward, everything manual-related will be consolidated into the
Doxygen manual, or the wiki.
Diffstat (limited to 'docs')
47 files changed, 1 insertions, 5055 deletions
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index b9eb977a3a..605022ef00 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -21,14 +21,12 @@ # Setup dependencies ######################################################################## find_package(Doxygen) -find_package(Sphinx) ######################################################################## # Register component ######################################################################## include(GrComponent) GR_REGISTER_COMPONENT("doxygen" ENABLE_DOXYGEN DOXYGEN_FOUND) -GR_REGISTER_COMPONENT("sphinx" ENABLE_SPHINX SPHINX_FOUND) ######################################################################## # Begin conditional configuration @@ -42,17 +40,3 @@ add_subdirectory(doxygen) add_subdirectory(exploring-gnuradio) endif(ENABLE_DOXYGEN) - - -######################################################################## -# Begin conditional configuration -######################################################################## -if(ENABLE_SPHINX) - - -######################################################################## -# Add subdirectories -######################################################################## -add_subdirectory(sphinx) - -endif(ENABLE_SPHINX) diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in index bd60d7cc3b..ac133c2279 100644 --- a/docs/doxygen/Doxyfile.in +++ b/docs/doxygen/Doxyfile.in @@ -747,7 +747,6 @@ EXCLUDE = @abs_top_srcdir@/volk \ @abs_top_srcdir@/cmake \ @abs_top_srcdir@/gr-utils/python/modtool/gr-newmod \ @abs_top_srcdir@/docs/doxygen/doxyxml/example \ - @abs_top_srcdir@/docs/sphinx \ @abs_top_srcdir@/gnuradio-runtime/lib \ @abs_top_builddir@/gnuradio-runtime/lib \ @abs_top_srcdir@/gr-analog/lib \ diff --git a/docs/doxygen/other/build_guide.dox.in b/docs/doxygen/other/build_guide.dox.in index 0791ce8ee0..b4c128a8db 100644 --- a/docs/doxygen/other/build_guide.dox.in +++ b/docs/doxygen/other/build_guide.dox.in @@ -109,10 +109,9 @@ Currently, ControlPort only supports the Apache Thrift backend. \li thrift (>= 0.9.2) https://thrift.apache.org/ -To have nice formula formatting in doxygen, you'll need LaTeX; for python docs, sphinx: +To have nice formula formatting in doxygen, you'll need LaTeX: \li latex (>= 2.0) http://www.latex-project.org/ -\li sphinx (>= 1.2.2) http://www.sphinx-doc.org/ \section build_gr_cmake Building GNU Radio diff --git a/docs/sphinx/CMakeLists.txt b/docs/sphinx/CMakeLists.txt deleted file mode 100644 index 23cb460517..0000000000 --- a/docs/sphinx/CMakeLists.txt +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2012 Free Software Foundation, Inc. -# -# This file is part of GNU Radio -# -# GNU Radio is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 3, or (at your option) -# any later version. -# -# GNU Radio is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with GNU Radio; see the file COPYING. If not, write to -# the Free Software Foundation, Inc., 51 Franklin Street, -# Boston, MA 02110-1301, USA. - -include(GrPython) - -configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/source/conf.py.in - ${CMAKE_CURRENT_BINARY_DIR}/conf.py -@ONLY) - -configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/run_sphinx_build.sh.in - ${CMAKE_BINARY_DIR}/run_sphinx_build.sh -@ONLY) - -if(UNIX) - #make the shell file executable - execute_process(COMMAND chmod +x ${CMAKE_BINARY_DIR}/run_sphinx_build.sh) -endif(UNIX) diff --git a/docs/sphinx/README b/docs/sphinx/README deleted file mode 100644 index 7d2c977d3b..0000000000 --- a/docs/sphinx/README +++ /dev/null @@ -1,72 +0,0 @@ -INTRODUCTION -The Sphinx documentation system uses the fully installed Python tree -to build a set of documents (generally in HTML). In GNU Radio, the -documentation system is done through Doxygen in the public header -(/include/foo.h) files. Doxygen first builds its documentation files, -then the swig_docs program uses Doxygen's XML output and smashed the -documentation from each header file into the SWIG'd Python -block. Basically, using a single documentation markup, Doxygen, we -expose the documentation strings in both the Doxygen-built manual and -within the Python blocks themselves. - -Sphinx takes this process one step farther by reading the docstrings -of all Python blocks and creating its own manual. This has two -benefits. First, the Sphinx documentation looks nice and is formatted -in such a way that Python users of GNU Radio can easy see the module -structure and hierarchy. It also not only takes the Doxygen -documentation from C++, but it also allows us to take any Python files -and include their documentation. - -The end result is two manuals: one for Python and one for C++ users -without having to duplicate comments, markup, or documentation. - - -BUILDING THE SPHINX MANUAL -Building the Sphinx docs takes some manual intervention as it -requires GNU Radio to already be installed. So first follow the steps -to build and install GNU Radio. - -In the build directory, a helper file is created called -run_sphinx_build.sh. This is a Linux shell script that runs the -sphinx-build command with all of the normal settings and important -directories preloaded. For non Linux systems, it should be easy to -pull out the executable and options to run it by hand. - -The run_sphinx_build.sh outputs the manual into -$builddir/docs/sphinx/sphinx_out. Open up the index.html file in a -browser to view it. - -ADDING NEW CONTENT TO THE SPHINX MANUAL -Although the content of the sphinx manual is automatically generated, -new blocks are not automatically added to the generated documentation. -The procedure for adding new content is best illustrated with two -examples. - -1) Adding a new C++ signal processing block gnuradio.gr.myslicer - Edit file gnuradio/docs/sphinx/source/gr/index.rst and add the line - > gnuradio.gr.myslicer - under the "Slicing and Dicing Streams" subheading. - Edit file gnuradio/docs/sphinx/source/gr/slicedice_blk.rst and add - the line - >.. autooldblock:: gnuradio.gr.myslicer - -2) Adding a new python hierarchical block gnuradio.digital.mymod - Edit file gnruadio/docs/sphinx/source/digital/index.rst and add the - line - > gnuradio.digital.mymod - under the "Signal Processing Blocks" subheading. - Edit file gnuradio/docs/sphinx/source/digital/blocks.rst and add - the line - >.. autopyblock:: gnuradio.digital.mymod - Notice that the 'autopyblock' directive is used rather than the - 'autoblock' directive. This lets sphinx know that it is displaying - a python hierarchical signal processing block so that it can format - it appropriately. - -The process for documenting objects that are not signal processing -blocks is similar but rather than using the 'autooldblock', and -'autopyblock' directives the standard sphinx directives such as -'autofunction' and 'autoclass' can be used. - -Finally for signal processing blocks using the 3.7 style the directive -'autoblock' rather than 'autooldblock' can be used.
\ No newline at end of file diff --git a/docs/sphinx/gnuradio_sphinx.py b/docs/sphinx/gnuradio_sphinx.py deleted file mode 100644 index cdfd46ceca..0000000000 --- a/docs/sphinx/gnuradio_sphinx.py +++ /dev/null @@ -1,223 +0,0 @@ -""" -Customizations of sphinx for gnuradio use. -""" -from __future__ import unicode_literals - -from sphinx.ext.autodoc import py_ext_sig_re -from sphinx.ext.autodoc import ClassDocumenter, FunctionDocumenter, members_option -from sphinx.ext.autodoc import bool_option, members_set_option, identity -from sphinx.ext.autodoc import ALL - -# A dictionary of the number of lines to delete from the beginning of docstrings -lines_to_delete = {} - -def setup(sp): - # Fix line-breaks in signature. - sp.connect('autodoc-process-signature', fix_signature) - sp.connect('autodoc-process-docstring', remove_lines) - # Add node to autodocument signal-processing blocks. - sp.add_autodocumenter(OldBlockDocumenter) - sp.add_autodocumenter(BlockDocumenter) - sp.add_autodocumenter(PyBlockDocumenter) - -def remove_lines(app, what, name, obj, options, lines): - del_lines = lines_to_delete.get(name, 0) - # Don't delete any lines if this is called again. - lines_to_delete[name] = 0 - lines[:] = lines[del_lines:] - -def fix_signature(app, what, name, obj, options, signature, return_annotation): - """ - SWIG produces signature at the top of docstrings of the form - 'blah(int arg1, float arg2) -> return_type' - and if the string is long it breaks it over multiple lines. - - Sphinx gets confused if it is broken over multiple lines. - fix_signature and remove_lines get around this problem. - """ - if return_annotation is not None: - return - - if hasattr(obj, '__doc__'): - docs = obj.__doc__ - else: - docs = None - if not docs: - return None - doclines = docs.split('\n') - del_lines = remove_linebreaks_in_signature(doclines) - # match first line of docstring against signature RE - match = py_ext_sig_re.match(doclines[0]) - if not match: - return None - exmod, path, base, args, retann = match.groups() - # ok, now jump over remaining empty lines and set the remaining - # lines as the new doclines - i = 1 - while i < len(doclines) and not doclines[i].strip(): - i += 1 - lines_to_delete[name] = i - 1 + del_lines - # format args - signature = "({0})".format(args) - return signature, retann - -def remove_linebreaks_in_signature(lines): - alllines = '\n'.join(lines) - alllines = alllines.lstrip() - bits = alllines.split('->') - if len(bits) == 1: - return 0 - after = '->'.join(bits[1:]) - after_lines = after.split('\n') - ending = None - remainder = [] - for line in after_lines: - if line and ending is None: - ending = line - elif ending is not None: - remainder.append(line) - first_line = ' '.join([a.strip() for a in bits[0].split('\n') if a.strip()]) + ' -> ' + ending.strip() - match = py_ext_sig_re.match(first_line) - # If it is a signature, make the change to lines. - if match: - new_lines = [first_line] + remainder - lines[:] = new_lines - return len(bits[0].split('\n')) - else: - return 0 - -# These methods are not displayed in the documentation of blocks to -# avoid redundancy. -common_block_members =[ - 'check_topology', - 'detail', - 'history', - 'input_signature', - 'name', - 'nitems_read', - 'nitems_written', - 'nthreads', - 'output_multiple', - 'output_signature', - 'relative_rate', - 'set_detail', - 'set_nthreads', - 'start', - 'stop', - 'thisown', - 'to_basic_block', - 'unique_id', - 'make', - 'alias', - 'is_set_max_noutput_items', - 'max_noutput_items', - 'max_output_buffer', - 'message_ports_in', - 'message_ports_out', - 'min_output_buffer', - 'pc_input_buffers_full', - 'pc_input_buffers_full_var', - 'pc_noutput_items', - 'pc_noutput_items_var', - 'pc_nproduced', - 'pc_nproduced_var', - 'pc_output_buffers_full', - 'pc_output_buffers_full_var', - 'pc_work_time', - 'pc_work_time_var', - 'processor_affinity', - 'set_block_alias', - 'set_max_noutput_items', - 'unset_max_noutput_items', - 'set_max_output_buffer', - 'set_min_output_buffer', - 'set_processor_affinity', - 'symbol_name', - 'unset_processor_affinity', - 'disconnect_all', - 'index', - 'length', - 'lock', - 'primitive_connect', - 'primitive_disconnect', - 'primitive_message_port_register_hier_in', - 'primitive_message_port_register_hier_out', - 'primitive_msg_connect', - 'primitive_msg_disconnect', - 'to_hier_block2', - 'type', - 'unlock', -] - -class OldBlockDocumenter(FunctionDocumenter): - """ - Specialized Documenter subclass for gnuradio blocks. - - It merges together the documentation for the generator function (e.g. blocks.head) - with the wrapped sptr (e.g. gr::blocks::head::sptr) to keep the documentation - tidier. - """ - objtype = 'oldblock' - directivetype = 'function' - # Don't want to use this for generic functions for give low priority. - priority = -10 - - def __init__(self, *args, **kwargs): - super(OldBlockDocumenter, self).__init__(*args, **kwargs) - # Get class name - bits = self.name.split('.') - if len(bits) != 3 or bits[0] != 'gnuradio': - raise ValueError("expected name to be of form gnuradio.x.y but it is {0}".format(self.name)) - sptr_name = 'gnuradio.{0}.{0}_{1}_sptr'.format(bits[1], bits[2]) - # Create a Class Documenter to create documentation for the classes members. - self.classdoccer = ClassDocumenter(self.directive, sptr_name, indent=self.content_indent) - self.classdoccer.doc_as_attr = False - self.classdoccer.real_modname = self.classdoccer.get_real_modname() - self.classdoccer.options.members = ALL - self.classdoccer.options.exclude_members = common_block_members - self.classdoccer.parse_name() - self.classdoccer.import_object() - - def document_members(self, *args, **kwargs): - return self.classdoccer.document_members(*args, **kwargs) - -class BlockDocumenter(FunctionDocumenter): - """ - Specialized Documenter subclass for new style gnuradio blocks. - - It merges together the documentation for the generator function (e.g. wavelet.squash_ff) - with the wrapped sptr (e.g. wavelet.squash_ff_sptr) to keep the documentation - tidier. - """ - objtype = 'block' - directivetype = 'function' - # Don't want to use this for generic functions for give low priority. - priority = -10 - - def __init__(self, *args, **kwargs): - super(BlockDocumenter, self).__init__(*args, **kwargs) - # Get class name - sptr_name = self.name + '_sptr' - # Create a Class Documenter to create documentation for the classes members. - self.classdoccer = ClassDocumenter(self.directive, sptr_name, indent=self.content_indent) - self.classdoccer.doc_as_attr = False - self.classdoccer.real_modname = self.classdoccer.get_real_modname() - self.classdoccer.options.members = ALL - self.classdoccer.options.exclude_members = common_block_members - self.classdoccer.parse_name() - self.classdoccer.import_object() - - def document_members(self, *args, **kwargs): - return self.classdoccer.document_members(*args, **kwargs) - -class PyBlockDocumenter(ClassDocumenter): - """ - Specialized Documenter subclass for hierarchical python gnuradio blocks. - """ - objtype = 'pyblock' - directivetype = 'class' - - def __init__(self, *args, **kwargs): - super(PyBlockDocumenter, self).__init__(*args, **kwargs) - self.options.members = ALL - self.options.exclude_members = common_block_members diff --git a/docs/sphinx/hieroglyph/LICENSE.txt b/docs/sphinx/hieroglyph/LICENSE.txt deleted file mode 100644 index 3f7a638305..0000000000 --- a/docs/sphinx/hieroglyph/LICENSE.txt +++ /dev/null @@ -1,26 +0,0 @@ -Copyright (c) 2011, Robert Smallshire -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - * Neither the name of Robert Smallshire nor the names of its contributors - may be used to endorse or promote products derived from this software - without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. diff --git a/docs/sphinx/hieroglyph/README.txt b/docs/sphinx/hieroglyph/README.txt deleted file mode 100644 index c26409d896..0000000000 --- a/docs/sphinx/hieroglyph/README.txt +++ /dev/null @@ -1,10 +0,0 @@ -Sphinx is a popular tool for documenting Python APIs which uses reStructuredText -as a its lightweight markup language. Sphinx extends restructured text with -semantic markup elements for documenting Python APIs but once these are used the -ratio of markup to content becomes too high and readability is compromised -enough that the docstring becomes unsuitable for use with standard Python -introspection mechanisms like help() or IDEs. - -Hieroglyph is an a Sphinx extension which automatically converts a highly -readable docstring format suitable for use with help() and IDEs to the -reStructuredText hieroglyphics required by Sphinx.
\ No newline at end of file diff --git a/docs/sphinx/hieroglyph/__init__.py b/docs/sphinx/hieroglyph/__init__.py deleted file mode 100644 index d6b00fc049..0000000000 --- a/docs/sphinx/hieroglyph/__init__.py +++ /dev/null @@ -1,7 +0,0 @@ -from __future__ import unicode_literals -# We only need to expose the setup function to Sphinx - -from .hieroglyph import setup -from .version import __version__ - -__author__ = 'Robert Smallshire' diff --git a/docs/sphinx/hieroglyph/errors.py b/docs/sphinx/hieroglyph/errors.py deleted file mode 100644 index 9f7cde9570..0000000000 --- a/docs/sphinx/hieroglyph/errors.py +++ /dev/null @@ -1,11 +0,0 @@ -from __future__ import unicode_literals - -from sphinx.errors import ExtensionError - -__author__ = 'rjs' - -class HieroglyphError(ExtensionError): - ''' - An exception type specific to the Hieroglyph Sphinx extension. - ''' - pass diff --git a/docs/sphinx/hieroglyph/hieroglyph.py b/docs/sphinx/hieroglyph/hieroglyph.py deleted file mode 100644 index bb58a6e04b..0000000000 --- a/docs/sphinx/hieroglyph/hieroglyph.py +++ /dev/null @@ -1,406 +0,0 @@ -from __future__ import print_function -from __future__ import absolute_import -from __future__ import unicode_literals - -import re - -from .errors import HieroglyphError -from .nodes import (Node, Raises, Except, Note, Warning, Returns, Arg, - ensure_terminal_blank) - -__author__ = 'Robert Smallshire' - -def parse_hieroglyph_text(lines): - '''Parse text in hieroglyph format and return a reStructuredText equivalent - - Args: - lines: A sequence of strings representing the lines of a single - docstring as read from the source by Sphinx. This string should be - in a format that can be parsed by hieroglyph. - - Returns: - A list of lines containing the transformed docstring as - reStructuredText as produced by hieroglyph. - - Raises: - RuntimeError: If the docstring cannot be parsed. - ''' - indent_lines = unindent(lines) - indent_lines = pad_blank_lines(indent_lines) - indent_lines = first_paragraph_indent(indent_lines) - indent_paragraphs = gather_lines(indent_lines) - parse_tree = group_paragraphs(indent_paragraphs) - syntax_tree = extract_structure(parse_tree) - result = syntax_tree.render_rst() - ensure_terminal_blank(result) - return result - - -def unindent(lines): - '''Convert an iterable of indented lines into a sequence of tuples. - - The first element of each tuple is the indent in number of characters, and - the second element is the unindented string. - - Args: - lines: A sequence of strings representing the lines of text in a docstring. - - Returns: - A list of tuples where each tuple corresponds to one line of the input - list. Each tuple has two entries - the first is an integer giving the - size of the indent in characters, the second is the unindented text. - ''' - unindented_lines = [] - for line in lines: - unindented_line = line.lstrip() - indent = len(line) - len(unindented_line) - unindented_lines.append((indent, unindented_line)) - return unindented_lines - - -def pad_blank_lines(indent_texts): - '''Give blank (empty) lines the same indent level as the preceding line. - - Args: - indent_texts: An iterable of tuples each containing an integer in the - first element and a string in the second element. - - Returns: - A list of tuples each containing an integer in the first element and a - string in the second element. - ''' - current_indent = 0 - result = [] - for indent, text in indent_texts: - if len(text) > 0: - current_indent = indent - result.append((current_indent, text)) - return result - - -def extract_structure(parse_tree): - '''Create an Abstract Syntax Tree representing the semantics of a parse tree. - - Args: - parse_tree: TODO - - Returns: - A Node with is the result of an Abstract Syntax Tree representing the - docstring. - - Raises: - HieroglyphError: In the event that the parse tree cannot be understood. - ''' - return convert_node(parse_tree) - - -def convert_node(node): - if node.indent == 0 and len(node.lines) == 0: - return convert_children(node) - if node.lines[0].startswith('Args:'): - return convert_args(node) - if node.lines[0].startswith('Returns:'): - return convert_returns(node) - if node.lines[0].startswith('Raises:'): - return convert_raises(node) - if node.lines[0].startswith('Note:'): - return convert_note(node) - if node.lines[0].startswith('Warning:'): - return convert_warning(node) - result = convert_children(node) - result.lines = node.lines - result.indent = node.indent - return result - - -def convert_children(node): - converted_children = [convert_node(child) for child in node.children] - result = Node() - result.children = converted_children - return result - - -ARG_REGEX = re.compile(r'(\*{0,2}\w+)(\s+\((\w+)\))?\s*:\s*(.*)') - -def append_child_to_args_group_node(child, group_node, indent): - arg = None - non_empty_lines = (line for line in child.lines if line) - for line in non_empty_lines: - m = ARG_REGEX.match(line) - if m is None: - raise HieroglyphError("Invalid hieroglyph argument syntax: {0}".format(line)) - param_name = m.group(1) - param_type = m.group(3) - param_text = m.group(4) - - arg = Arg(indent, child.indent, param_name) - group_node.children.append(arg) - arg.type = param_type - - if param_text is not None: - arg.children.append(Node(indent, [param_text], arg)) - if arg is not None: - last_child = arg.children[-1] if len(arg.children) != 0 else arg - for grandchild in child.children: - last_child.children.append(grandchild) - - -def convert_args(node): - assert node.lines[0].startswith('Args:') - group_node = Node() - for child in node.children: - append_child_to_args_group_node(child, group_node, node.indent) - return group_node - - -def convert_returns(node): - assert node.lines[0].startswith('Returns:') - returns = Returns(node.indent) - returns.line = node.lines[0][8:].strip() - returns.children = node.children - return returns - - -def convert_note(node): - assert node.lines[0].startswith('Note:') - note = Note(node.indent) - note.line = node.lines[0][5:].strip() - note.children = node.children - return note - - -def convert_warning(node): - assert node.lines[0].startswith('Warning:') - warning = Warning(node.indent) - warning.line = node.lines[0][8:].strip() - warning.children = node.children - return warning - - -def convert_raises(node): - assert node.lines[0].startswith('Raises:') - group_node = Raises(node.indent) - for child in node.children: - append_child_to_raise_node(child, group_node) - return group_node - - -RAISE_REGEX = re.compile(r'(\w+)\s*:\s*(.*)') - -def extract_exception_type_and_text(line): - m = RAISE_REGEX.match(line) - if m is None: - raise HieroglyphError("Invalid hieroglyph exception syntax: {0}".format(line)) - return (m.group(2), m.group(1)) - - -def append_child_to_raise_node(child, group_node): - exception = None - non_empty_lines = (line for line in child.lines if line) - for line in non_empty_lines: - exception_text, exception_type = extract_exception_type_and_text(line) - - exception = Except(child.indent, exception_type) - group_node.children.append(exception) # TODO: Could use parent here. - - if exception_text is not None: - exception.children.append( Node(child.indent, - [exception_text], exception)) - if exception is not None: - last_child = exception.children[-1] if len(exception.children) != 0 else exception - for grandchild in child.children: - last_child.children.append(grandchild) - - -def group_paragraphs(indent_paragraphs): - ''' - Group paragraphs so that more indented paragraphs become children of less - indented paragraphs. - ''' - # The tree consists of tuples of the form (indent, [children]) where the - # children may be strings or other tuples - - root = Node(0, [], None) - current_node = root - - previous_indent = -1 - for indent, lines in indent_paragraphs: - if indent > previous_indent: - current_node = create_child_node(current_node, indent, lines) - elif indent == previous_indent: - current_node = create_sibling_node(current_node, indent, lines) - elif indent < previous_indent: - current_node = create_uncle_node(current_node, indent, lines) - previous_indent = indent - return root - - -def create_sibling_node(current_node, indent, lines): - sibling = Node(indent, lines, current_node.parent) - current_node.parent.add_child(sibling) - current_node = sibling - return current_node - - -def create_child_node(current_node, indent, lines): - child = Node(indent, lines, current_node) - current_node.add_child(child) - current_node = child - return current_node - - -def create_uncle_node(current_node, indent, lines): - ancestor = current_node - while ancestor.indent >= indent: - if ancestor.parent is None: - break - ancestor = ancestor.parent - uncle = Node(indent, lines, ancestor) - ancestor.add_child(uncle) - current_node = uncle - return current_node - - -def gather_lines(indent_lines): - '''Split the list of (int, str) tuples into a list of (int, [str]) tuples - to group the lines into paragraphs of consistent indent. - ''' - return remove_empty_paragraphs(split_separated_lines(gather_lines_by_indent(indent_lines))) - -def gather_lines_by_indent(indent_lines): - result = [] - previous_indent = -1 - for indent, line in indent_lines: - if indent != previous_indent: - paragraph = (indent, []) - result.append(paragraph) - else: - paragraph = result[-1] - paragraph[1].append(line) - previous_indent = indent - return result - -def split_separated_lines(indent_paragraphs): - result = [] - for indent, paragraph in indent_paragraphs: - result.append((indent, [])) - - if len(paragraph) > 0: - result[-1][1].append(paragraph[0]) - - if len(paragraph) > 2: - for line in paragraph[1: -1]: - result[-1][1].append(line) - if len(line) == 0: - result.append((indent, [])) - - if len(paragraph) > 1: - result[-1][1].append(paragraph[-1]) - - return result - -def remove_empty_paragraphs(indent_paragraphs): - return [(indent, paragraph) for indent, paragraph in indent_paragraphs if len(paragraph)] - -def first_paragraph_indent(indent_texts): - '''Fix the indentation on the first paragraph. - - This occurs because the first line of a multi-line docstring following the - opening quote usually has no indent. - - Args: - indent_texts: The lines of the docstring as an iterable over 2-tuples - each containing an integer indent level as the first element and - the text as the second element. - - Return: - A list of 2-tuples, each containing an integer indent level as the - first element and the text as the second element. - ''' - opening_indent = determine_opening_indent(indent_texts) - - result = [] - input = iter(indent_texts) - for indent, text in input: - if indent == 0: - result.append((opening_indent, text)) - else: - result.append((indent, text)) - break - - for indent, text in input: - result.append((indent, text)) - - return result - - -def determine_opening_indent(indent_texts): - '''Determine the opening indent level for a docstring. - - The opening indent level is the indent level is the first non-zero indent - level of a non-empty line in the docstring. - - Args: - indent_texts: The lines of the docstring as an iterable over 2-tuples - each containing an integer indent level as the first element and - the text as the second element. - - Returns: - The opening indent level as an integer. - ''' - num_lines = len(indent_texts) - - if num_lines < 1: - return 0 - - assert num_lines >= 1 - - first_line_indent = indent_texts[0][0] - - if num_lines == 1: - return first_line_indent - - assert num_lines >= 2 - - second_line_indent = indent_texts[1][0] - second_line_text = indent_texts[1][1] - - if len(second_line_text) == 0: - return first_line_indent - - return second_line_indent - - - -def rewrite_autodoc(app, what, name, obj, options, lines): - '''Convert lines from Hieroglyph to Sphinx format. - - The function to be called by the Sphinx autodoc extension when autodoc - has read and processed a docstring. This function modified its - ``lines`` argument *in place* replacing Hieroglyph syntax input into - Sphinx reStructuredText output. - - Args: - apps: The Sphinx application object. - - what: The type of object which the docstring belongs to. One of - 'module', 'class', 'exception', 'function', 'method', 'attribute' - - name: The fully qualified name of the object. - - obj: The object itself. - - options: The options given to the directive. An object with attributes - ``inherited_members``, ``undoc_members``, ``show_inheritance`` and - ``noindex`` that are ``True`` if the flag option of the same name - was given to the auto directive. - - lines: The lines of the docstring. Will be modified *in place*. - ''' - lines[:] = parse_hieroglyph_text(lines) - - -def setup(app): - app.connect('autodoc-process-docstring', rewrite_autodoc) - - diff --git a/docs/sphinx/hieroglyph/nodes.py b/docs/sphinx/hieroglyph/nodes.py deleted file mode 100644 index 1c091ab6a0..0000000000 --- a/docs/sphinx/hieroglyph/nodes.py +++ /dev/null @@ -1,268 +0,0 @@ -from __future__ import unicode_literals -__author__ = 'Robert Smallshire' - -class Node(object): - - def __init__(self, indent=None, lines=None, parent=None): - if indent is not None: - self.indent = indent - else: - self.indent = 0 - - if lines is not None: - self.lines = lines - else: - self.lines = [] - - self._parent = parent - - self.children = [] - - parent = property(lambda self: self._parent) - - def add_child(self, child): - assert(child.parent is self) - self.children.append(child) - - - def __repr__(self): - return "Node(" + repr(self.indent) + ", " + repr(self.lines) + ", children=" + repr(self.children) + ")" - - - def render_rst(self, *args, **kwargs): - result = [] - prefix = ' ' * self.indent - result.extend(prefix + line for line in self.lines) - for child in self.children: - result.extend(child.render_rst()) - return result - - - -class Arg(Node): - - def __init__(self, indent, child_indent, name): - super(Arg, self).__init__(indent) - self.child_indent = child_indent - self.name = name - self.type = None - - - def __repr__(self): - return "Arg(" + repr(self.name) + ", " + repr(self.type) + ", children=" + repr(self.children) + ")" - - - def render_rst(self, *args, **kwargs): - result = [] - indent = ' ' * self.indent - - # Render the param description - description = [] - for child in self.children: - child_lines = child.render_rst() - description.extend(child_lines) - - dedent = self.child_indent - self.indent - - name = self.name.replace('*', r'\*') - - first_description = description[0].lstrip() if len(description) else '' - if not first_description: - # TODO: Emit a warning about a missing argument description - pass - - result.append("{indent}:param {name}: {first_description}".format(indent=indent, name=name, - first_description=first_description)) - - dedented_body = [line[dedent:] for line in description[1:]] - - result.extend(dedented_body) - - # If a type was specified render the type - if self.type is not None: - result.append("{indent}:type {name}: {type}".format(indent=indent, name=self.name, type=self.type)) - result.append('') - - ensure_terminal_blank(result) - - return result - - - -class Raises(Node): - - def __init__(self, indent=None): - super(Raises, self).__init__(indent=indent) - - def __repr__(self): - return "Raises(" + repr(self.indent) + ", children=" + repr(self.children) + ")" - - - def render_rst(self, *args, **kwargs): - result = [] - indent = ' ' * self.indent - result.append(indent + ':raises:') - for child in self.children: - result.extend(child.render_rst(only_child=len(self.children) == 1)) - - ensure_terminal_blank(result) - - return result - - -class Except(Node): - - def __init__(self, indent, type): - super(Except, self).__init__(indent=indent) - #self.child_indent = child_indent - self.type = type - - - def __repr__(self): - return "Except(" + repr(self.type) + ", children=" + repr(self.children) + ")" - - - def render_rst(self, only_child=False, *args, **kwargs): - result = [] - indent = ' ' * self.indent - - # Render the param description - description = [] - for child in self.children: - child_lines = child.render_rst() - description.extend(child_lines) - - #dedent = self.child_indent - self.indent - bullet = '* ' if not only_child else '' - - first_description = description[0].lstrip() if len(description) else '' - result.append("{indent}{bullet}{type} - {first_description}".format(indent=indent, - bullet=bullet, type=self.type, - first_description=first_description)) - - #dedented_body = [' ' * len(bullet) + line[dedent:] for line in description[1:]] - #result.extend(dedented_body) - result.extend(description[1:]) - ensure_terminal_blank(result) - - return result - - - -class Returns(Node): - - def __init__(self, indent): - super(Returns, self).__init__(indent=indent) - self.title = 'Returns' - self.line = '' - - - def __repr__(self): - return "Returns(" + str(self.indent) + ", children=" + str(self.children) + ")" - - - def render_rst(self, *args, **kwargs): - result = [] - indent = ' ' * self.indent - - # Render the param description - description = [self.line] if self.line else [] - for child in self.children: - child_lines = child.render_rst() - description.extend(child_lines) - - self.render_title(description, indent, result) - - result.extend(description[1:]) - - ensure_terminal_blank(result) - return result - - - def render_title(self, description, indent, result): - result.append( - "{indent}:returns: {first_description}".format(indent=indent, - first_description=description[0].lstrip())) - - - -class Warning(Node): - - def __init__(self, indent): - super(Warning, self).__init__(indent=indent) - - def __repr__(self): - return "Warning(" + repr(self.indent) + ", children=" + str(self.children) + ")" - - def render_rst(self, *args, **kwargs): - # TODO: Factor out the commonality between this and Note below - result = [] - indent = ' ' * self.indent - - # Render the param description - description = [self.line] if self.line else [] - for child in self.children: - child_lines = child.render_rst() - description.extend(child_lines) - - # Fix the indent on the first line - if len(description) > 1 and len(description[1].strip()) != 0: - body_indent = len(description[1]) - len(description[1].strip()) - else: - body_indent = self.indent + 4 - - if len(description) > 0: - description[0] = ' ' * body_indent + description[0] - - result.append(indent + ".. warning::") - result.append(indent + '') - result.extend(description) - - ensure_terminal_blank(result) - return result - - -class Note(Node): - - def __init__(self, indent): - super(Note, self).__init__(indent=indent) - self.line = '' - - - def __repr__(self): - return "Note(" + repr(self.indent) + ", children=" + str(self.children) + ")" - - - def render_rst(self, *args, **kwargs): - # TODO: Factor out the commonality between this and Warning above - result = [] - indent = ' ' * self.indent - - # Render the param description - description = [self.line] if self.line else [] - for child in self.children: - child_lines = child.render_rst() - description.extend(child_lines) - - # Fix the indent on the first line - if len(description) > 1 and len(description[1].strip()) != 0: - body_indent = len(description[1]) - len(description[1].strip()) - else: - body_indent = self.indent + 4 - - if len(description) > 0: - description[0] = ' ' * body_indent + description[0] - - result.append(indent + ".. note::") - result.append(indent + '') - result.extend(description) - - ensure_terminal_blank(result) - return result - - -def ensure_terminal_blank(result): - '''If the description didn't end with a blank line add one here.''' - if len(result) > 0: - if len(result[-1].strip()) != 0: - result.append('') diff --git a/docs/sphinx/hieroglyph/test/__init__.py b/docs/sphinx/hieroglyph/test/__init__.py deleted file mode 100644 index c568b0851f..0000000000 --- a/docs/sphinx/hieroglyph/test/__init__.py +++ /dev/null @@ -1,2 +0,0 @@ -from __future__ import unicode_literals -__author__ = 'rjs' diff --git a/docs/sphinx/hieroglyph/test/test_comments.py b/docs/sphinx/hieroglyph/test/test_comments.py deleted file mode 100644 index 1a26e50e48..0000000000 --- a/docs/sphinx/hieroglyph/test/test_comments.py +++ /dev/null @@ -1,586 +0,0 @@ -from __future__ import unicode_literals -import unittest - -from hieroglyph.hieroglyph import parse_hieroglyph_text -from hieroglyph.errors import HieroglyphError - -class CommentTests(unittest.TestCase): - - def test_comment1(self): - source = """Fetches rows from a Bigtable. - This is a continuation of the opening paragraph. - - Retrieves rows pertaining to the given keys from the Table instance - represented by big_table. Silly things may happen if - other_silly_variable is not None. - - Args: - big_table: An open Bigtable Table instance. - keys: A sequence of strings representing the key of each table row - to fetch. - other_silly_variable (str): Another optional variable, that has a much - longer name than the other args, and which does nothing. - - Returns: - A dict mapping keys to the corresponding table row data - fetched. Each row is represented as a tuple of strings. For - example: - - {'Serak': ('Rigel VII', 'Preparer'), - 'Zim': ('Irk', 'Invader'), - 'Lrrr': ('Omicron Persei 8', 'Emperor')} - - If a key from the keys argument is missing from the dictionary, - then that row was not found in the table. - - Raises: - IOError: An error occurred accessing the bigtable.Table object. - """ - - expected = """ Fetches rows from a Bigtable. - This is a continuation of the opening paragraph. - - Retrieves rows pertaining to the given keys from the Table instance - represented by big_table. Silly things may happen if - other_silly_variable is not None. - - :param big_table: An open Bigtable Table instance. - - :param keys: A sequence of strings representing the key of each table row - to fetch. - - :param other_silly_variable: Another optional variable, that has a much - longer name than the other args, and which does nothing. - - :type other_silly_variable: str - - :returns: A dict mapping keys to the corresponding table row data - fetched. Each row is represented as a tuple of strings. For - example: - - {'Serak': ('Rigel VII', 'Preparer'), - 'Zim': ('Irk', 'Invader'), - 'Lrrr': ('Omicron Persei 8', 'Emperor')} - - If a key from the keys argument is missing from the dictionary, - then that row was not found in the table. - - :raises: - IOError - An error occurred accessing the bigtable.Table object. - """ - source_lines = source.splitlines() - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment2(self): - source = """Determine if all elements in the source sequence satisfy a condition. - - All of the source sequence will be consumed. - - Note: This method uses immediate execution. - - Args: - predicate: An optional single argument function used to test each - elements. If omitted, the bool() function is used resulting in - the elements being tested directly. - - Returns: - True if all elements in the sequence meet the predicate condition, - otherwise False. - - Raises: - ValueError: If the Queryable is closed() - TypeError: If predicate is not callable. - """ - - expected = """Determine if all elements in the source sequence satisfy a condition. - - All of the source sequence will be consumed. - - .. note:: - - This method uses immediate execution. - - :param predicate: An optional single argument function used to test each - elements. If omitted, the bool() function is used resulting in - the elements being tested directly. - - :returns: True if all elements in the sequence meet the predicate condition, - otherwise False. - - :raises: - * ValueError - If the Queryable is closed() - - * TypeError - If predicate is not callable. - """ - source_lines = source.splitlines() - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment3(self): - source = """Determine if all elements in the source sequence satisfy a condition. - - All of the source sequence will be consumed. - - Note: This method uses immediate execution. - - Args: - predicate: An optional single argument function used to test each - elements. If omitted, the bool() function is used resulting in - the elements being tested directly. - - Returns: - True if all elements in the sequence meet the predicate condition, - otherwise False. - - Raises: - ValueError: If the Queryable is closed() - TypeError: If predicate is not callable. - """ - - expected = """Determine if all elements in the source sequence satisfy a condition. - - All of the source sequence will be consumed. - - .. note:: - - This method uses immediate execution. - - :param predicate: An optional single argument function used to test each - elements. If omitted, the bool() function is used resulting in - the elements being tested directly. - - :returns: True if all elements in the sequence meet the predicate condition, - otherwise False. - - :raises: - * ValueError - If the Queryable is closed() - - * TypeError - If predicate is not callable. - """ - source_lines = source.splitlines() - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment4(self): - source_lines = [u'Determine if all elements in the source sequence satisfy a condition.', - u'', - u'All of the source sequence will be consumed.', - u'', - u'Note: This method uses immediate execution.', - u'', - u'Args:', - u' predicate: An optional single argument function used to test each', - u' elements. If omitted, the bool() function is used resulting in', - u' the elements being tested directly.', - u'', - u'Returns:', - u' True if all elements in the sequence meet the predicate condition,', - u' otherwise False.', - u'', - u'Raises:', - u' ValueError: If the Queryable is closed()', - u' TypeError: If predicate is not callable.', - u''] - - expected = """Determine if all elements in the source sequence satisfy a condition. - -All of the source sequence will be consumed. - -.. note:: - - This method uses immediate execution. - -:param predicate: An optional single argument function used to test each - elements. If omitted, the bool() function is used resulting in - the elements being tested directly. - -:returns: True if all elements in the sequence meet the predicate condition, - otherwise False. - -:raises: - * ValueError - If the Queryable is closed() - - * TypeError - If predicate is not callable. - -""" - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment5(self): - source_lines = [u'An empty Queryable.', - u'', - u'Note: The same empty instance will be returned each time.', - u'', - u'Returns: A Queryable over an empty sequence.', - u''] - - expected = """An empty Queryable. - -.. note:: - - The same empty instance will be returned each time. - -:returns: A Queryable over an empty sequence. - -""" - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment6(self): - source_lines = [u'A convenience factory for creating Records.', - u'', - u'Args:', - u' **kwargs: Each keyword argument will be used to initialise an', - u' attribute with the same name as the argument and the given', - u' value.', - u'', - u'Returns:', - u' A Record which has a named attribute for each of the keyword arguments.', - u''] - - expected = r"""A convenience factory for creating Records. - -:param \*\*kwargs: Each keyword argument will be used to initialise an - attribute with the same name as the argument and the given - value. - -:returns: A Record which has a named attribute for each of the keyword arguments. - -""" - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment7(self): - source = """Projects each element of a sequence to an intermediate new sequence, - flattens the resulting sequences into one sequence and optionally - transforms the flattened sequence using a selector function. - - Note: This method uses deferred execution. - - Args: - collection_selector: A unary function mapping each element of the - source iterable into an intermediate sequence. The single - argument of the collection_selector is the value of an element - from the source sequence. The return value should be an - iterable derived from that element value. The default - collection_selector, which is the identity function, assumes - that each element of the source sequence is itself iterable. - - result_selector: An optional unary function mapping the elements in - the flattened intermediate sequence to corresponding elements - of the result sequence. The single argument of the - result_selector is the value of an element from the flattened - intermediate sequence. The return value should be the - corresponding value in the result sequence. The default - result_selector is the identity function. - - Returns: - A Queryable over a generated sequence whose elements are the result - of applying the one-to-many collection_selector to each element of - the source sequence, concatenating the results into an intermediate - sequence, and then mapping each of those elements through the - result_selector into the result sequence. - - Raises: - ValueError: If this Queryable has been closed. - TypeError: If either collection_selector or result_selector are not - callable. - """ - - expected = """ Projects each element of a sequence to an intermediate new sequence, - flattens the resulting sequences into one sequence and optionally - transforms the flattened sequence using a selector function. - - .. note:: - - This method uses deferred execution. - - :param collection_selector: A unary function mapping each element of the - source iterable into an intermediate sequence. The single - argument of the collection_selector is the value of an element - from the source sequence. The return value should be an - iterable derived from that element value. The default - collection_selector, which is the identity function, assumes - that each element of the source sequence is itself iterable. - - :param result_selector: An optional unary function mapping the elements in - the flattened intermediate sequence to corresponding elements - of the result sequence. The single argument of the - result_selector is the value of an element from the flattened - intermediate sequence. The return value should be the - corresponding value in the result sequence. The default - result_selector is the identity function. - - :returns: A Queryable over a generated sequence whose elements are the result - of applying the one-to-many collection_selector to each element of - the source sequence, concatenating the results into an intermediate - sequence, and then mapping each of those elements through the - result_selector into the result sequence. - - :raises: - * ValueError - If this Queryable has been closed. - - * TypeError - If either collection_selector or result_selector are not - callable. - """ - source_lines = source.splitlines() - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment8(self): - source = """A convenience factory for creating Records. - - Args: - **kwargs: Each keyword argument will be used to initialise an - attribute with the same name as the argument and the given - value. - - Returns: - A Record which has a named attribute for each of the keyword arguments. - """ - - expected = r"""A convenience factory for creating Records. - - :param \*\*kwargs: Each keyword argument will be used to initialise an - attribute with the same name as the argument and the given - value. - - :returns: A Record which has a named attribute for each of the keyword arguments. - -""" - source_lines = source.splitlines() - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment9(self): - source_lines = [u'Parse a single line of a tree to determine depth and node.', - u'', - u'Args:', - u' This line is missing an argument name.', - u' ', - u'Returns:', - u' A 2-tuple containing the tree 0 based tree depth as the first', - u' element and the node description as the second element.', - u'', - u'Raises:', - u' ValueError: If line does not have the expected form.', - u''] - - self.assertRaises(HieroglyphError, lambda: parse_hieroglyph_text(source_lines)) - - def test_comment10(self): - source = """ - Execute the command described by concatenating the string function arguments - with the p4 -s global scripting flag and return the results in a dictionary. - - For example, to run the command:: - - p4 -s fstat -T depotFile foo.h - - call:: - - p4('fstat', '-T', 'depotFile', 'foo.h') - - Args: - args: The arguments to the p4 command as a list of objects which will - be converted to strings. - - Returns: - A dictionary of lists where each key in the dictionary is the field name - from the command output, and each value is a list of output lines in - order. - - Raises: - PerforceError: If the command could not be run or if the command - reported an error. - """ - - expected = """ - Execute the command described by concatenating the string function arguments - with the p4 -s global scripting flag and return the results in a dictionary. - - For example, to run the command:: - - p4 -s fstat -T depotFile foo.h - - call:: - - p4('fstat', '-T', 'depotFile', 'foo.h') - - :param args: The arguments to the p4 command as a list of objects which will - be converted to strings. - - :returns: A dictionary of lists where each key in the dictionary is the field name - from the command output, and each value is a list of output lines in - order. - - :raises: - PerforceError - If the command could not be run or if the command - reported an error. - -""" - - source_lines = source.splitlines() - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment11(self): - source = """Projects each element of a sequence to an intermediate new sequence, - flattens the resulting sequences into one sequence and optionally - transforms the flattened sequence using a selector function. - - Warning: This method may explode at short notice. - - Args: - collection_selector: A unary function mapping each element of the - source iterable into an intermediate sequence. The single - argument of the collection_selector is the value of an element - from the source sequence. The return value should be an - iterable derived from that element value. The default - collection_selector, which is the identity function, assumes - that each element of the source sequence is itself iterable. - - result_selector: An optional unary function mapping the elements in - the flattened intermediate sequence to corresponding elements - of the result sequence. The single argument of the - result_selector is the value of an element from the flattened - intermediate sequence. The return value should be the - corresponding value in the result sequence. The default - result_selector is the identity function. - - Returns: - A Queryable over a generated sequence whose elements are the result - of applying the one-to-many collection_selector to each element of - the source sequence, concatenating the results into an intermediate - sequence, and then mapping each of those elements through the - result_selector into the result sequence. - - Raises: - ValueError: If this Queryable has been closed. - TypeError: If either collection_selector or result_selector are not - callable. - """ - - expected = """ Projects each element of a sequence to an intermediate new sequence, - flattens the resulting sequences into one sequence and optionally - transforms the flattened sequence using a selector function. - - .. warning:: - - This method may explode at short notice. - - :param collection_selector: A unary function mapping each element of the - source iterable into an intermediate sequence. The single - argument of the collection_selector is the value of an element - from the source sequence. The return value should be an - iterable derived from that element value. The default - collection_selector, which is the identity function, assumes - that each element of the source sequence is itself iterable. - - :param result_selector: An optional unary function mapping the elements in - the flattened intermediate sequence to corresponding elements - of the result sequence. The single argument of the - result_selector is the value of an element from the flattened - intermediate sequence. The return value should be the - corresponding value in the result sequence. The default - result_selector is the identity function. - - :returns: A Queryable over a generated sequence whose elements are the result - of applying the one-to-many collection_selector to each element of - the source sequence, concatenating the results into an intermediate - sequence, and then mapping each of those elements through the - result_selector into the result sequence. - - :raises: - * ValueError - If this Queryable has been closed. - - * TypeError - If either collection_selector or result_selector are not - callable. - """ - source_lines = source.splitlines() - actual_lines = parse_hieroglyph_text(source_lines) - expected_lines = expected.splitlines() - self.assertEqual(len(actual_lines), len(expected_lines)) - for actual_line, result_line in zip(actual_lines, expected_lines): - if len(actual_line.strip()) == 0: - self.assertTrue(len(result_line.strip()) == 0) - else: - self.assertEqual(actual_line, result_line) - - def test_comment12(self): - source = """Determine if all elements in the source sequence satisfy a condition. - - All of the source sequence will be consumed. - - Note: This method uses immediate execution. - - Args: - predicate: An optional single argument function used to test each - elements. If omitted, the bool() function is used resulting in - the elements being tested directly. - - Returns: - True if all elements in the sequence meet the predicate condition, - otherwise False. - - Raises: - This is not a proper exception description - """ - - source_lines = source.splitlines() - self.assertRaises(HieroglyphError, lambda: parse_hieroglyph_text(source_lines)) diff --git a/docs/sphinx/hieroglyph/test/test_hierglyph.py b/docs/sphinx/hieroglyph/test/test_hierglyph.py deleted file mode 100644 index 7815960905..0000000000 --- a/docs/sphinx/hieroglyph/test/test_hierglyph.py +++ /dev/null @@ -1,265 +0,0 @@ -from __future__ import unicode_literals -import unittest -from hieroglyph.hieroglyph import first_paragraph_indent, gather_lines, unindent - -__author__ = 'Robert Smallshire' - -class UnindentTests(unittest.TestCase): - - def test_zero_lines(self): - source = [] - expected = [] - actual = unindent(source) - self.assertEqual(actual, expected) - - def test_one_zero_indent_line(self): - source = ["First line"] - expected = [(0, "First line")] - actual = unindent(source) - self.assertEqual(actual, expected) - - def test_two_zero_indent_lines(self): - source = ["First line", - "Second line"] - expected = [(0, "First line"), - (0, "Second line")] - actual = unindent(source) - self.assertEqual(actual, expected) - - def test_two_indented_lines(self): - source = [" First line", - " Second line"] - expected = [(4, "First line"), - (6, "Second line")] - actual = unindent(source) - self.assertEqual(actual, expected) - - def test_whitespace_line(self): - source = [" "] - expected = [(4, "")] - actual = unindent(source) - self.assertEqual(actual, expected) - - def test_tab_line(self): - source = ["\tHello"] - expected = [(1, "Hello")] - actual = unindent(source) - self.assertEqual(actual, expected) - - -class FirstParagraphIndentTests(unittest.TestCase): - - def test_zero_lines(self): - source = [] - expected = [] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_single_line_non_indented_comment(self): - source = [(0, "A single line comment")] - expected = [(0, "A single line comment")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_single_line_indented_comment(self): - source = [(4, "A single line comment")] - expected = [(4, "A single line comment")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_double_line_non_indented_comment(self): - source = [(0, "The first line"), - (0, "The second line")] - expected = [(0, "The first line"), - (0, "The second line")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_double_line_indented_comment(self): - source = [(4, "The first line"), - (4, "The second line")] - expected = [(4, "The first line"), - (4, "The second line")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_first_line_indent(self): - source = [(4, "The first line"), - (0, "The second line")] - expected = [(4, "The first line"), - (0, "The second line")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_first_line_non_indent(self): - source = [(0, "The first line"), - (4, "The second line")] - expected = [(4, "The first line"), - (4, "The second line")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_increasing_indent(self): - source = [(0, "The first line"), - (4, "The second line"), - (8, "The third line")] - expected = [(4, "The first line"), - (4, "The second line"), - (8, "The third line")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_separate_paragraphs(self): - source = [(0, "This is the first paragraph"), - (0, ""), - (4, "This is the second paragraph")] - expected = [(0, "This is the first paragraph"), - (0, ""), - (4, "This is the second paragraph")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_separate_paragraphs_indented(self): - source = [(4, "This is the first paragraph"), - (4, ""), - (8, "This is the second paragraph")] - expected = [(4, "This is the first paragraph"), - (4, ""), - (8, "This is the second paragraph")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_separated_lines_first_line_non_indented(self): - source = [(0, "The first line"), - (0, ""), - (4, "The third line")] - expected = [(0, "The first line"), - (0, ""), - (4, "The third line")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - - def test_separated_lines_first_line_indented(self): - source = [(4, "The first line"), - (4, ""), - (4, "The third line")] - expected = [(4, "The first line"), - (4, ""), - (4, "The third line")] - actual = first_paragraph_indent(source) - self.assertEqual(actual, expected) - -class GatherLinesTests(unittest.TestCase): - - def test_empty(self): - source = [] - expected = [] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_one_liner(self): - source = [(0, 'One liner')] - expected = [(0, ['One liner'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_two_liner(self): - source = [(0, 'First line'), - (0, 'Second line')] - expected = [(0, ['First line', - 'Second line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_separated_lines(self): - source = [(0, 'First line'), - (0, ''), - (0, 'Third line')] - expected = [(0, ['First line', - '']), - (0, ['Third line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_separated_multi_lines(self): - source = [(0, 'First line'), - (0, 'Second line'), - (0, ''), - (0, 'Fourth line'), - (0, 'Fifth line')] - expected = [(0, ['First line', - 'Second line', - '']), - (0, ['Fourth line', - 'Fifth line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - - def test_indented_lines(self): - source = [(0, 'First line'), - (4, 'Second line')] - expected = [(0, ['First line']), - (4, ['Second line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_dedented_lines(self): - source = [(4, 'First line'), - (0, 'Second line')] - expected = [(4, ['First line']), - (0, ['Second line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_indented_multi_lines(self): - source = [(0, 'First line'), - (0, 'Second line'), - (4, 'Third line'), - (4, 'Fourth line')] - expected = [(0, ['First line', - 'Second line']), - (4, ['Third line', - 'Fourth line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_dedented_multi_lines(self): - source = [(4, 'First line'), - (4, 'Second line'), - (0, 'Third line'), - (0, 'Fourth line')] - expected = [(4, ['First line', - 'Second line']), - (0, ['Third line', - 'Fourth line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_indented_separated_multi_lines(self): - source = [(0, 'First line'), - (0, 'Second line'), - (0, ''), - (4, 'Fourth line'), - (4, 'Fifth line')] - expected = [(0, ['First line', - 'Second line', - '']), - (4, ['Fourth line', - 'Fifth line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) - - def test_dedented_separated_multi_lines(self): - source = [(4, 'First line'), - (4, 'Second line'), - (4, ''), - (0, 'Fourth line'), - (0, 'Fifth line')] - expected = [(4, ['First line', - 'Second line', - '']), - (0, ['Fourth line', - 'Fifth line'])] - actual = gather_lines(source) - self.assertEqual(actual, expected) diff --git a/docs/sphinx/hieroglyph/test/test_nodes.py b/docs/sphinx/hieroglyph/test/test_nodes.py deleted file mode 100644 index 4b6003c91a..0000000000 --- a/docs/sphinx/hieroglyph/test/test_nodes.py +++ /dev/null @@ -1,387 +0,0 @@ -from __future__ import unicode_literals -import unittest -from hieroglyph.nodes import Node, Arg, Raises, Except, Returns, Warning, Note - -__author__ = 'Robert Smallshire' - -class NodeTests(unittest.TestCase): - - def test_create_default_node(self): - node = Node() - self.assertEqual(node.indent, 0) - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_create_with_indent(self): - node = Node(indent=4) - self.assertEqual(node.indent, 4) - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_create_with_lines(self): - node = Node(lines= ['First', 'Second', 'Third']) - self.assertEqual(node.indent, 0) - self.assertEqual(node.lines, ['First', 'Second', 'Third']) - self.assertIsNone(node.parent) - - def test_repr(self): - node = Node(5, ['One', 'Two', 'Three']) - actual = repr(node) - expected = "Node(5, ['One', 'Two', 'Three'], children=[])" - self.assertEqual(expected, actual) - - def test_add_one_child(self): - node = Node() - child = Node(parent=node) - node.add_child(child) - self.assertIs(node.children[0], child) - - def test_add_two_children(self): - node = Node() - child0 = Node(parent=node) - child1 = Node(parent=node) - node.add_child(child0) - node.add_child(child1) - self.assertIs(node.children[0], child0) - self.assertIs(node.children[1], child1) - - def test_render_rst_empty(self): - node = Node() - rst = node.render_rst() - self.assertEqual(len(rst), 0) - - def test_render_rst_indent(self): - node = Node(indent=4) - rst = node.render_rst() - self.assertEqual(len(rst), 0) - - def test_render_rst_lines(self): - node = Node(lines= ['First', - 'Second', - 'Third']) - rst = node.render_rst() - self.assertEqual(rst, ['First', - 'Second', - 'Third']) - - def test_render_rst_indented_lines(self): - node = Node(indent=3, lines= ['First', - 'Second', - 'Third']) - rst = node.render_rst() - self.assertEqual(rst, [' First', - ' Second', - ' Third']) - - def test_render_rst_with_child(self): - node = Node(indent=4, lines=["Parent"]) - child = Node(indent=8, lines=["Child"], parent=node) - node.add_child(child) - rst = node.render_rst() - self.assertEqual(rst, [' Parent', - ' Child']) - - def test_render_rst_with_children(self): - node = Node(indent=4, lines=["Parent"]) - child_a = Node(indent=8, lines=["ChildA"], parent=node) - node.add_child(child_a) - child_b = Node(indent=6, lines=["ChildB"], parent=node) - node.add_child(child_b) - rst = node.render_rst() - self.assertEqual(rst, [' Parent', - ' ChildA', - ' ChildB']) - - -class ArgTests(unittest.TestCase): - - def test_create(self): - node = Arg(5, 10, 'foo') - self.assertEqual(node.indent, 5) - self.assertEqual(node.child_indent, 10) - self.assertEqual(node.name, 'foo') - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_set_type(self): - node = Arg(5, 10, 'foo') - node.type = 'str' - self.assertEqual(node.type, 'str') - - def test_add_one_child(self): - node = Arg(5, 10, 'foo') - child = Node(parent=node) - node.add_child(child) - self.assertIs(node.children[0], child) - - def test_add_two_children(self): - node = Arg(5, 10, 'foo') - child0 = Node(parent=node) - child1 = Node(parent=node) - node.add_child(child0) - node.add_child(child1) - self.assertIs(node.children[0], child0) - self.assertIs(node.children[1], child1) - - def test_repr(self): - node = Arg(5, 10, 'foo') - actual = repr(node) - expected = "Arg('foo', None, children=[])" - self.assertEqual(expected, actual) - - def test_render_rst_empty(self): - node = Arg(5, 10, 'bar') - rst = node.render_rst() - self.assertEqual(rst, [' :param bar: ', - '']) - - def test_render_rst_with_child(self): - node = Arg(5, 10, 'bar') - child = Node(indent=10, lines=["Description"], parent=node) - node.add_child(child) - rst = node.render_rst() - self.assertEqual(rst, [' :param bar: Description', - '']) - - def test_render_rst_with_children(self): - node = Arg(5, 10, 'bar') - child_a = Node(indent=10, lines=["ChildA"], parent=node) - node.add_child(child_a) - child_b = Node(indent=10, lines=["ChildB"], parent=node) - node.add_child(child_b) - rst = node.render_rst() - self.assertEqual(rst, [' :param bar: ChildA', - ' ChildB', - '']) - - def test_render_rst_with_type(self): - node = Arg(5, 10, 'bar') - node.type = 'str' - rst = node.render_rst() - self.assertEqual(rst, [' :param bar: ', - ' :type bar: str', - '']) - - -class RaisesTests(unittest.TestCase): - - def test_create_default_node(self): - node = Raises() - self.assertEqual(node.indent, 0) - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_create_with_indent(self): - node = Raises(indent=4) - self.assertEqual(node.indent, 4) - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_repr(self): - node = Raises(5) - actual = repr(node) - expected = "Raises(5, children=[])" - self.assertEqual(expected, actual) - - def test_add_one_child(self): - node = Raises() - child = Node(parent=node) - node.add_child(child) - self.assertIs(node.children[0], child) - - def test_add_two_children(self): - node = Raises() - child0 = Node(parent=node) - child1 = Node(parent=node) - node.add_child(child0) - node.add_child(child1) - self.assertIs(node.children[0], child0) - self.assertIs(node.children[1], child1) - - def test_render_rst_empty(self): - node = Raises() - rst = node.render_rst() - self.assertEqual(rst, [':raises:', - '']) - - def test_render_rst_indent(self): - node = Raises(indent=5) - rst = node.render_rst() - self.assertEqual(rst, [' :raises:', - '']) - - def test_render_rst_with_child(self): - node = Raises(5) - child = Node(indent=10, lines=["Description"], parent=node) - node.add_child(child) - rst = node.render_rst() - self.assertEqual(rst, [' :raises:', - ' Description', - '']) - - def test_render_rst_with_children(self): - node = Raises(5) - child_a = Node(indent=10, lines=["ChildA"], parent=node) - node.add_child(child_a) - child_b = Node(indent=10, lines=["ChildB"], parent=node) - node.add_child(child_b) - rst = node.render_rst() - self.assertEqual(rst, [' :raises:', - ' ChildA', - ' ChildB', - '']) - - -class ExceptTests(unittest.TestCase): - - def test_create(self): - node = Except(5, 'FooError') - self.assertEqual(node.indent, 5) - self.assertEqual(node.type, 'FooError') - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_add_one_child(self): - node = Except(5, 'FooError') - child = Node(parent=node) - node.add_child(child) - self.assertIs(node.children[0], child) - - def test_add_two_children(self): - node = Except(5, 'FooError') - child0 = Node(parent=node) - child1 = Node(parent=node) - node.add_child(child0) - node.add_child(child1) - self.assertIs(node.children[0], child0) - self.assertIs(node.children[1], child1) - - def test_repr(self): - node = Except(5,'FooError') - actual = repr(node) - expected = "Except('FooError', children=[])" - self.assertEqual(expected, actual) - - def test_render_rst_empty(self): - node = Except(5, 'FooError') - rst = node.render_rst() - self.assertEqual(rst, [' * FooError - ', - '']) - - def test_render_rst_indent(self): - node = Except(5, 'FooError') - rst = node.render_rst() - self.assertEqual(rst, [' * FooError - ', - '']) - - def test_render_rst_with_child(self): - node = Except(5, 'FooError') - child = Node(indent=10, lines=["Description"], parent=node) - node.add_child(child) - rst = node.render_rst() - self.assertEqual(rst, [' * FooError - Description', - '']) - - def test_render_rst_with_children(self): - node = Except(5, 'FooError') - child_a = Node(indent=10, lines=["ChildA"], parent=node) - node.add_child(child_a) - child_b = Node(indent=10, lines=["ChildB"], parent=node) - node.add_child(child_b) - rst = node.render_rst() - self.assertEqual(rst, [' * FooError - ChildA', - ' ChildB', - '']) - -class ReturnsTests(unittest.TestCase): - - def test_create(self): - node = Returns(5) - self.assertEqual(node.indent, 5) - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_add_one_child(self): - node = Returns(5) - child = Node(parent=node) - node.add_child(child) - self.assertIs(node.children[0], child) - - def test_add_two_children(self): - node = Returns(5) - child0 = Node(parent=node) - child1 = Node(parent=node) - node.add_child(child0) - node.add_child(child1) - self.assertIs(node.children[0], child0) - self.assertIs(node.children[1], child1) - - def test_repr(self): - node = Returns(5) - actual = repr(node) - expected = "Returns(5, children=[])" - self.assertEqual(expected, actual) - - # TODO test_render_rst - -class WarningTests(unittest.TestCase): - - def test_create(self): - node = Warning(5) - self.assertEqual(node.indent, 5) - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_add_one_child(self): - node = Warning(5) - child = Node(parent=node) - node.add_child(child) - self.assertIs(node.children[0], child) - - def test_add_two_children(self): - node = Warning(5) - child0 = Node(parent=node) - child1 = Node(parent=node) - node.add_child(child0) - node.add_child(child1) - self.assertIs(node.children[0], child0) - self.assertIs(node.children[1], child1) - - def test_repr(self): - node = Warning(5) - actual = repr(node) - expected = "Warning(5, children=[])" - self.assertEqual(expected, actual) - - # TODO test_render_rst - -class NoteTests(unittest.TestCase): - - def test_create(self): - node = Note(5) - self.assertEqual(node.indent, 5) - self.assertEqual(node.lines, []) - self.assertIsNone(node.parent) - - def test_add_one_child(self): - node = Note(5) - child = Node(parent=node) - node.add_child(child) - self.assertIs(node.children[0], child) - - def test_add_two_children(self): - node = Note(5) - child0 = Node(parent=node) - child1 = Node(parent=node) - node.add_child(child0) - node.add_child(child1) - self.assertIs(node.children[0], child0) - self.assertIs(node.children[1], child1) - - def test_repr(self): - node = Note(5) - actual = repr(node) - expected = "Note(5, children=[])" - self.assertEqual(expected, actual) - - # TODO test_render_rst diff --git a/docs/sphinx/hieroglyph/version.py b/docs/sphinx/hieroglyph/version.py deleted file mode 100644 index f823af4363..0000000000 --- a/docs/sphinx/hieroglyph/version.py +++ /dev/null @@ -1,4 +0,0 @@ -'''Specification of the hieroglyph version''' -from __future__ import unicode_literals - -__version__ = '0.6' diff --git a/docs/sphinx/run_sphinx_build.sh.in b/docs/sphinx/run_sphinx_build.sh.in deleted file mode 100644 index c9681657dd..0000000000 --- a/docs/sphinx/run_sphinx_build.sh.in +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash - -echo "Creating Sphinx documentation in: @CMAKE_CURRENT_BINARY_DIR@/sphinx_out" - -LD_LIBRARY_PATH="@CMAKE_INSTALL_PREFIX@/lib:$LD_LIBRARY_PATH" -@SPHINX_EXECUTABLE@ -b html -c @CMAKE_CURRENT_BINARY_DIR@/ @CMAKE_CURRENT_SOURCE_DIR@/source @CMAKE_CURRENT_BINARY_DIR@/sphinx_out - diff --git a/docs/sphinx/source/analog.rst b/docs/sphinx/source/analog.rst deleted file mode 100644 index 0bbaba6185..0000000000 --- a/docs/sphinx/source/analog.rst +++ /dev/null @@ -1,21 +0,0 @@ -gnuradio.analog -=============== - -.. autoclass:: gnuradio.analog.cpm -.. autoclass:: gnuradio.analog.squelch_base_cc -.. autoclass:: gnuradio.analog.squelch_base_ff -.. autoclass:: gnuradio.analog.am_demod_cf -.. autoclass:: gnuradio.analog.demod_10k0a3e_cf -.. autoclass:: gnuradio.analog.fm_demod_cf -.. autoclass:: gnuradio.analog.demod_20k0f3e_cf -.. autoclass:: gnuradio.analog.demod_200kf3e_cf -.. autoclass:: gnuradio.analog.fm_deemph -.. autoclass:: gnuradio.analog.fm_preemph -.. autoclass:: gnuradio.analog.nbfm_rx -.. autoclass:: gnuradio.analog.nbfm_tx -.. autoclass:: gnuradio.analog.ctcss_gen_f -.. autoclass:: gnuradio.analog.standard_squelch -.. autoclass:: gnuradio.analog.wfm_rcv_fmdet -.. autoclass:: gnuradio.analog.wfm_rcv_pll -.. autoclass:: gnuradio.analog.wfm_rcv -.. autoclass:: gnuradio.analog.wfm_tx diff --git a/docs/sphinx/source/analog_blocks.rst b/docs/sphinx/source/analog_blocks.rst deleted file mode 100644 index 5c5adfd43c..0000000000 --- a/docs/sphinx/source/analog_blocks.rst +++ /dev/null @@ -1,41 +0,0 @@ -gnuradio.analog -=============== - -.. automodule:: gnuradio.analog - -.. autoblock:: gnuradio.analog.agc2_cc -.. autoblock:: gnuradio.analog.agc2_ff -.. autoblock:: gnuradio.analog.agc3_cc -.. autoblock:: gnuradio.analog.agc_cc -.. autoblock:: gnuradio.analog.agc_ff -.. autoblock:: gnuradio.analog.cpfsk_bc -.. autoblock:: gnuradio.analog.ctcss_squelch_ff -.. autoblock:: gnuradio.analog.dpll_bb -.. autoblock:: gnuradio.analog.fastnoise_source_c -.. autoblock:: gnuradio.analog.fastnoise_source_f -.. autoblock:: gnuradio.analog.fastnoise_source_i -.. autoblock:: gnuradio.analog.fastnoise_source_s -.. autoblock:: gnuradio.analog.feedforward_agc_cc -.. autoblock:: gnuradio.analog.fmdet_cf -.. autoblock:: gnuradio.analog.frequency_modulator_fc -.. autoblock:: gnuradio.analog.noise_source_c -.. autoblock:: gnuradio.analog.noise_source_f -.. autoblock:: gnuradio.analog.noise_source_i -.. autoblock:: gnuradio.analog.noise_source_s -.. autoblock:: gnuradio.analog.phase_modulator_fc -.. autoblock:: gnuradio.analog.pll_carriertracking_cc -.. autoblock:: gnuradio.analog.pll_freqdet_cf -.. autoblock:: gnuradio.analog.pll_refout_cc -.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_c -.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_cf -.. autoblock:: gnuradio.analog.probe_avg_mag_sqrd_f -.. autoblock:: gnuradio.analog.pwr_squelch_cc -.. autoblock:: gnuradio.analog.pwr_squelch_ff -.. autoblock:: gnuradio.analog.quadrature_demod_cf -.. autoblock:: gnuradio.analog.rail_ff -.. autoblock:: gnuradio.analog.sig_source_c -.. autoblock:: gnuradio.analog.sig_source_f -.. autoblock:: gnuradio.analog.sig_source_i -.. autoblock:: gnuradio.analog.sig_source_s -.. autoblock:: gnuradio.analog.sig_source_b -.. autoblock:: gnuradio.analog.simple_squelch_cc diff --git a/docs/sphinx/source/audio_blocks.rst b/docs/sphinx/source/audio_blocks.rst deleted file mode 100644 index 31d53567b8..0000000000 --- a/docs/sphinx/source/audio_blocks.rst +++ /dev/null @@ -1,7 +0,0 @@ -gnuradio.audio -============== - -.. automodule:: gnuradio.audio - -.. autoblock:: gnuradio.audio.source -.. autoblock:: gnuradio.audio.sink diff --git a/docs/sphinx/source/blocks_blocks.rst b/docs/sphinx/source/blocks_blocks.rst deleted file mode 100644 index 5780d753bd..0000000000 --- a/docs/sphinx/source/blocks_blocks.rst +++ /dev/null @@ -1,227 +0,0 @@ -gnuradio.blocks -=============== - -.. automodule:: gnuradio.blocks - -.. autoblock:: gnuradio.blocks.abs_ff -.. autoblock:: gnuradio.blocks.abs_ii -.. autoblock:: gnuradio.blocks.abs_ss -.. autoblock:: gnuradio.blocks.add_cc -.. autoblock:: gnuradio.blocks.add_const_bb -.. autoblock:: gnuradio.blocks.add_const_cc -.. autoblock:: gnuradio.blocks.add_const_ff -.. autoblock:: gnuradio.blocks.add_const_ii -.. autoblock:: gnuradio.blocks.add_const_ss -.. autoblock:: gnuradio.blocks.add_const_vbb -.. autoblock:: gnuradio.blocks.add_const_vcc -.. autoblock:: gnuradio.blocks.add_const_vff -.. autoblock:: gnuradio.blocks.add_const_vii -.. autoblock:: gnuradio.blocks.add_const_vss -.. autoblock:: gnuradio.blocks.add_ff -.. autoblock:: gnuradio.blocks.add_ii -.. autoblock:: gnuradio.blocks.add_ss -.. autoblock:: gnuradio.blocks.and_bb -.. autoblock:: gnuradio.blocks.and_const_bb -.. autoblock:: gnuradio.blocks.and_const_ii -.. autoblock:: gnuradio.blocks.and_const_ss -.. autoblock:: gnuradio.blocks.and_ii -.. autoblock:: gnuradio.blocks.and_ss -.. autoblock:: gnuradio.blocks.annotator_1to1 -.. autoblock:: gnuradio.blocks.annotator_alltoall -.. autoblock:: gnuradio.blocks.annotator_raw -.. autoblock:: gnuradio.blocks.argmax_fs -.. autoblock:: gnuradio.blocks.argmax_is -.. autoblock:: gnuradio.blocks.argmax_ss -.. autoblock:: gnuradio.blocks.bin_statistics_f -.. autoblock:: gnuradio.blocks.burst_tagger -.. autoblock:: gnuradio.blocks.char_to_float -.. autoblock:: gnuradio.blocks.char_to_short -.. autoblock:: gnuradio.blocks.check_lfsr_32k_s -.. autoblock:: gnuradio.blocks.complex_to_arg -.. autoblock:: gnuradio.blocks.complex_to_float -.. autoblock:: gnuradio.blocks.complex_to_imag -.. autoblock:: gnuradio.blocks.complex_to_interleaved_short -.. autoblock:: gnuradio.blocks.complex_to_mag -.. autoblock:: gnuradio.blocks.complex_to_mag_squared -.. autoblock:: gnuradio.blocks.complex_to_real -.. autoblock:: gnuradio.blocks.conjugate_cc -.. autoblock:: gnuradio.blocks.copy -.. autoblock:: gnuradio.blocks.ctrlport_probe2_b -.. autoblock:: gnuradio.blocks.ctrlport_probe2_c -.. autoblock:: gnuradio.blocks.ctrlport_probe2_f -.. autoblock:: gnuradio.blocks.ctrlport_probe2_i -.. autoblock:: gnuradio.blocks.ctrlport_probe2_s -.. autoblock:: gnuradio.blocks.ctrlport_probe_c -.. autoblock:: gnuradio.blocks.deinterleave -.. autoblock:: gnuradio.blocks.delay -.. autoblock:: gnuradio.blocks.divide_cc -.. autoblock:: gnuradio.blocks.divide_ff -.. autoblock:: gnuradio.blocks.divide_ii -.. autoblock:: gnuradio.blocks.divide_ss -.. autoblock:: gnuradio.blocks.endian_swap -.. autoblock:: gnuradio.blocks.file_descriptor_sink -.. autoblock:: gnuradio.blocks.file_descriptor_source -.. autoblock:: gnuradio.blocks.file_meta_sink -.. autoblock:: gnuradio.blocks.file_meta_source -.. autoblock:: gnuradio.blocks.file_sink -.. autoblock:: gnuradio.blocks.file_source -.. autoblock:: gnuradio.blocks.float_to_char -.. autoblock:: gnuradio.blocks.float_to_complex -.. autoblock:: gnuradio.blocks.float_to_int -.. autoblock:: gnuradio.blocks.float_to_short -.. autoblock:: gnuradio.blocks.float_to_uchar -.. autoblock:: gnuradio.blocks.head -.. autoblock:: gnuradio.blocks.int_to_float -.. autoblock:: gnuradio.blocks.integrate_cc -.. autoblock:: gnuradio.blocks.integrate_ff -.. autoblock:: gnuradio.blocks.integrate_ii -.. autoblock:: gnuradio.blocks.integrate_ss -.. autoblock:: gnuradio.blocks.interleave -.. autoblock:: gnuradio.blocks.interleaved_char_to_complex -.. autoblock:: gnuradio.blocks.interleaved_short_to_complex -.. autoblock:: gnuradio.blocks.keep_m_in_n -.. autoblock:: gnuradio.blocks.keep_one_in_n -.. autoblock:: gnuradio.blocks.lfsr_32k_source_s -.. autoblock:: gnuradio.blocks.max_ff -.. autoblock:: gnuradio.blocks.max_ii -.. autoblock:: gnuradio.blocks.max_ss -.. autoblock:: gnuradio.blocks.message_burst_source -.. autoblock:: gnuradio.blocks.message_debug -.. autoblock:: gnuradio.blocks.message_strobe -.. autoblock:: gnuradio.blocks.message_strobe_random -.. autoblock:: gnuradio.blocks.min_ff -.. autoblock:: gnuradio.blocks.min_ii -.. autoblock:: gnuradio.blocks.min_ss -.. autoblock:: gnuradio.blocks.moving_average_cc -.. autoblock:: gnuradio.blocks.moving_average_ff -.. autoblock:: gnuradio.blocks.moving_average_ii -.. autoblock:: gnuradio.blocks.moving_average_ss -.. autoblock:: gnuradio.blocks.multiply_cc -.. autoblock:: gnuradio.blocks.multiply_conjugate_cc -.. autoblock:: gnuradio.blocks.multiply_const_cc -.. autoblock:: gnuradio.blocks.multiply_const_ff -.. autoblock:: gnuradio.blocks.multiply_const_ii -.. autoblock:: gnuradio.blocks.multiply_const_ss -.. autoblock:: gnuradio.blocks.multiply_const_vcc -.. autoblock:: gnuradio.blocks.multiply_const_vff -.. autoblock:: gnuradio.blocks.multiply_const_vii -.. autoblock:: gnuradio.blocks.multiply_const_vss -.. autoblock:: gnuradio.blocks.multiply_ff -.. autoblock:: gnuradio.blocks.multiply_ii -.. autoblock:: gnuradio.blocks.multiply_matrix_ff -.. autoblock:: gnuradio.blocks.multiply_ss -.. autoblock:: gnuradio.blocks.mute_cc -.. autoblock:: gnuradio.blocks.mute_ff -.. autoblock:: gnuradio.blocks.mute_ii -.. autoblock:: gnuradio.blocks.mute_ss -.. autoblock:: gnuradio.blocks.nlog10_ff -.. autoblock:: gnuradio.blocks.nop -.. autoblock:: gnuradio.blocks.not_bb -.. autoblock:: gnuradio.blocks.not_ii -.. autoblock:: gnuradio.blocks.not_ss -.. autoblock:: gnuradio.blocks.null_sink -.. autoblock:: gnuradio.blocks.null_source -.. autoblock:: gnuradio.blocks.or_bb -.. autoblock:: gnuradio.blocks.or_ii -.. autoblock:: gnuradio.blocks.or_ss -.. autoblock:: gnuradio.blocks.pack_k_bits_bb -.. autoblock:: gnuradio.blocks.packed_to_unpacked_bb -.. autoblock:: gnuradio.blocks.packed_to_unpacked_ii -.. autoblock:: gnuradio.blocks.packed_to_unpacked_ss -.. autoblock:: gnuradio.blocks.patterned_interleaver -.. autoblock:: gnuradio.blocks.pdu_filter -.. autoblock:: gnuradio.blocks.pdu_remove -.. autoblock:: gnuradio.blocks.pdu_set -.. autoblock:: gnuradio.blocks.pdu_to_tagged_stream -.. autoblock:: gnuradio.blocks.peak_detector2_fb -.. autoblock:: gnuradio.blocks.peak_detector_fb -.. autoblock:: gnuradio.blocks.peak_detector_ib -.. autoblock:: gnuradio.blocks.peak_detector_sb -.. autoblock:: gnuradio.blocks.plateau_detector_fb -.. autoblock:: gnuradio.blocks.probe_rate -.. autoblock:: gnuradio.blocks.probe_signal_b -.. autoblock:: gnuradio.blocks.probe_signal_c -.. autoblock:: gnuradio.blocks.probe_signal_f -.. autoblock:: gnuradio.blocks.probe_signal_i -.. autoblock:: gnuradio.blocks.probe_signal_s -.. autoblock:: gnuradio.blocks.probe_signal_vb -.. autoblock:: gnuradio.blocks.probe_signal_vc -.. autoblock:: gnuradio.blocks.probe_signal_vf -.. autoblock:: gnuradio.blocks.probe_signal_vi -.. autoblock:: gnuradio.blocks.probe_signal_vs -.. autoblock:: gnuradio.blocks.random_pdu -.. autoblock:: gnuradio.blocks.regenerate_bb -.. autoblock:: gnuradio.blocks.repack_bits_bb -.. autoblock:: gnuradio.blocks.repeat -.. autoblock:: gnuradio.blocks.rms_cf -.. autoblock:: gnuradio.blocks.rms_ff -.. autoblock:: gnuradio.blocks.rotator_cc -.. autoblock:: gnuradio.blocks.sample_and_hold_bb -.. autoblock:: gnuradio.blocks.sample_and_hold_ff -.. autoblock:: gnuradio.blocks.sample_and_hold_ii -.. autoblock:: gnuradio.blocks.sample_and_hold_ss -.. autoblock:: gnuradio.blocks.short_to_char -.. autoblock:: gnuradio.blocks.short_to_float -.. autoblock:: gnuradio.blocks.skiphead -.. autoblock:: gnuradio.blocks.socket_pdu -.. autoblock:: gnuradio.blocks.stream_mux -.. autoblock:: gnuradio.blocks.stream_to_streams -.. autoblock:: gnuradio.blocks.stream_to_tagged_stream -.. autoblock:: gnuradio.blocks.stream_to_vector -.. autoblock:: gnuradio.blocks.streams_to_stream -.. autoblock:: gnuradio.blocks.streams_to_vector -.. autoblock:: gnuradio.blocks.stretch_ff -.. autoblock:: gnuradio.blocks.sub_cc -.. autoblock:: gnuradio.blocks.sub_ff -.. autoblock:: gnuradio.blocks.sub_ii -.. autoblock:: gnuradio.blocks.sub_ss -.. autoblock:: gnuradio.blocks.tag_debug -.. autoblock:: gnuradio.blocks.tag_gate -.. autoblock:: gnuradio.blocks.tagged_file_sink -.. autoblock:: gnuradio.blocks.tagged_stream_align -.. autoblock:: gnuradio.blocks.tagged_stream_multiply_length -.. autoblock:: gnuradio.blocks.tagged_stream_mux -.. autoblock:: gnuradio.blocks.tagged_stream_to_pdu -.. autoblock:: gnuradio.blocks.tags_strobe -.. autoblock:: gnuradio.blocks.tcp_server_sink -.. autoblock:: gnuradio.blocks.threshold_ff -.. autoblock:: gnuradio.blocks.throttle -.. autoblock:: gnuradio.blocks.transcendental -.. autoblock:: gnuradio.blocks.tsb_vector_sink_b -.. autoblock:: gnuradio.blocks.tsb_vector_sink_c -.. autoblock:: gnuradio.blocks.tsb_vector_sink_f -.. autoblock:: gnuradio.blocks.tsb_vector_sink_i -.. autoblock:: gnuradio.blocks.tsb_vector_sink_s -.. autoblock:: gnuradio.blocks.tuntap_pdu -.. autoblock:: gnuradio.blocks.uchar_to_float -.. autoblock:: gnuradio.blocks.udp_sink -.. autoblock:: gnuradio.blocks.udp_source -.. autoblock:: gnuradio.blocks.unpack_k_bits_bb -.. autoblock:: gnuradio.blocks.unpacked_to_packed_bb -.. autoblock:: gnuradio.blocks.unpacked_to_packed_ii -.. autoblock:: gnuradio.blocks.unpacked_to_packed_ss -.. autoblock:: gnuradio.blocks.vco_c -.. autoblock:: gnuradio.blocks.vco_f -.. autoblock:: gnuradio.blocks.vector_insert_b -.. autoblock:: gnuradio.blocks.vector_insert_c -.. autoblock:: gnuradio.blocks.vector_insert_f -.. autoblock:: gnuradio.blocks.vector_insert_i -.. autoblock:: gnuradio.blocks.vector_insert_s -.. autoblock:: gnuradio.blocks.vector_map -.. autoblock:: gnuradio.blocks.vector_sink_b -.. autoblock:: gnuradio.blocks.vector_sink_c -.. autoblock:: gnuradio.blocks.vector_sink_f -.. autoblock:: gnuradio.blocks.vector_sink_i -.. autoblock:: gnuradio.blocks.vector_sink_s -.. autoblock:: gnuradio.blocks.vector_source_b -.. autoblock:: gnuradio.blocks.vector_source_c -.. autoblock:: gnuradio.blocks.vector_source_f -.. autoblock:: gnuradio.blocks.vector_source_i -.. autoblock:: gnuradio.blocks.vector_source_s -.. autoblock:: gnuradio.blocks.vector_to_stream -.. autoblock:: gnuradio.blocks.vector_to_streams -.. autoblock:: gnuradio.blocks.wavfile_sink -.. autoblock:: gnuradio.blocks.wavfile_source -.. autoblock:: gnuradio.blocks.xor_bb -.. autoblock:: gnuradio.blocks.xor_ii -.. autoblock:: gnuradio.blocks.xor_ss diff --git a/docs/sphinx/source/channels.rst b/docs/sphinx/source/channels.rst deleted file mode 100644 index cd2fb368b2..0000000000 --- a/docs/sphinx/source/channels.rst +++ /dev/null @@ -1,12 +0,0 @@ -gnuradio.channels -================= - -.. autoclass:: gnuradio.channels.amp_bal -.. autoclass:: gnuradio.channels.conj_fs_iqcorr -.. autoclass:: gnuradio.channels.distortion_2_gen -.. autoclass:: gnuradio.channels.distortion_3_gen -.. autoclass:: gnuradio.channels.impairments -.. autoclass:: gnuradio.channels.iqbal_gen -.. autoclass:: gnuradio.channels.phase_bal -.. autoclass:: gnuradio.channels.phase_noise_gen -.. autoclass:: gnuradio.channels.quantizer diff --git a/docs/sphinx/source/channels_blocks.rst b/docs/sphinx/source/channels_blocks.rst deleted file mode 100644 index f8213aa26e..0000000000 --- a/docs/sphinx/source/channels_blocks.rst +++ /dev/null @@ -1,12 +0,0 @@ -gnuradio.channels -================= - -.. automodule:: gnuradio.channels - -.. autoblock:: gnuradio.channels.channel_model -.. autoblock:: gnuradio.channels.channel_model2 -.. autoblock:: gnuradio.channels.fading_model -.. autoblock:: gnuradio.channels.selective_fading_model -.. autoblock:: gnuradio.channels.dynamic_channel_model -.. autoblock:: gnuradio.channels.cfo_model -.. autoblock:: gnuradio.channels.sro_model diff --git a/docs/sphinx/source/conf.py.in b/docs/sphinx/source/conf.py.in deleted file mode 100644 index aa7b122cc9..0000000000 --- a/docs/sphinx/source/conf.py.in +++ /dev/null @@ -1,217 +0,0 @@ -# -*- coding: utf-8 -*- -# -# GNU Radio documentation build configuration file, created by -# sphinx-quickstart on Sun Oct 16 22:27:51 2011. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('@CMAKE_CURRENT_SOURCE_DIR@')) -sys.path.insert(0, '@CMAKE_INSTALL_PREFIX@/@GR_PYTHON_DIR@') - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.autosummary', 'sphinx.ext.mathjax', 'gnuradio_sphinx', 'hieroglyph'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'GNU Radio' -copyright = u'2012, Free Software Foundation' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '@VERSION@' -# The full version, including alpha/beta/rc tags. -release = '@VERSION@' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'GNURadiodoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'GNURadio.tex', u'GNU Radio Documentation', - u'Free Software Foundation', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'gnuradio', u'GNU Radio Documentation', - [u'Free Software Foundation'], 1) -] diff --git a/docs/sphinx/source/digital.rst b/docs/sphinx/source/digital.rst deleted file mode 100644 index 415f4a3929..0000000000 --- a/docs/sphinx/source/digital.rst +++ /dev/null @@ -1,106 +0,0 @@ -gnuradio.digital -================ - -.. autoclass:: gnuradio.digital.constellation -.. autoclass:: gnuradio.digital.lfsr -.. autoclass:: gnuradio.digital.mpsk_snr_est -.. autoclass:: gnuradio.digital.simple_framer -.. autoclass:: gnuradio.digital.bpsk_mod -.. autoclass:: gnuradio.digital.bpsk_demod -.. autoclass:: gnuradio.digital.dbpsk_mod -.. autoclass:: gnuradio.digital.dbpsk_demod -.. autofunction:: gnuradio.digital.crc32 -.. autofunction:: gnuradio.digital.update_crc32 -.. autofunction:: gnuradio.digital.constellation_map_generator -.. autoclass:: gnuradio.digital.cpm_mod -.. autofunction:: gnuradio.digital.gen_and_append_crc32 -.. autofunction:: gnuradio.digital.check_crc32 -.. autoclass:: gnuradio.digital.generic_mod -.. autoclass:: gnuradio.digital.generic_demod -.. autoclass:: gnuradio.digital.gfsk_mod -.. autoclass:: gnuradio.digital.gfsk_demod -.. autoclass:: gnuradio.digital.gmsk_mod -.. autoclass:: gnuradio.digital.gmsk_demod -.. autofunction:: gnuradio.digital.type_1_mods -.. autofunction:: gnuradio.digital.add_type_1_mod -.. autofunction:: gnuradio.digital.type_1_demods -.. autofunction:: gnuradio.digital.add_type_1_demod -.. autofunction:: gnuradio.digital.type_1_constellations -.. autofunction:: gnuradio.digital.add_type_1_constellation -.. autofunction:: gnuradio.digital.extract_kwargs_from_options -.. autofunction:: gnuradio.digital.extract_kwargs_from_options_for_class -.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_packed_binary_string_to_1_0_string -.. autofunction:: gnuradio.digital.ofdm_packet_utils.conv_1_0_string_to_packed_binary_string -.. autofunction:: gnuradio.digital.ofdm_packet_utils.is_1_0_string -.. autofunction:: gnuradio.digital.ofdm_packet_utils.string_to_hex_list -.. autofunction:: gnuradio.digital.ofdm_packet_utils.whiten -.. autofunction:: gnuradio.digital.ofdm_packet_utils.dewhiten -.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_header -.. autofunction:: gnuradio.digital.ofdm_packet_utils.make_packet -.. autofunction:: gnuradio.digital.ofdm_packet_utils.unmake_packet -.. autoclass:: gnuradio.digital.ofdm_mod -.. autoclass:: gnuradio.digital.ofdm_demod -.. autoclass:: gnuradio.digital.ofdm_receiver -.. autoclass:: gnuradio.digital.ofdm_sync_fixed -.. autoclass:: gnuradio.digital.ofdm_sync_ml -.. autoclass:: gnuradio.digital.ofdm_sync_pnac -.. autoclass:: gnuradio.digital.ofdm_sync_pn -.. autoclass:: gnuradio.digital.ofdm_tx -.. autoclass:: gnuradio.digital.ofdm_rx -.. autofunction:: gnuradio.digital.packet_utils.conv_packed_binary_string_to_1_0_string -.. autofunction:: gnuradio.digital.packet_utils.conv_1_0_string_to_packed_binary_string -.. autofunction:: gnuradio.digital.packet_utils.is_1_0_string -.. autofunction:: gnuradio.digital.packet_utils.string_to_hex_list -.. autofunction:: gnuradio.digital.packet_utils.whiten -.. autofunction:: gnuradio.digital.packet_utils.dewhiten -.. autofunction:: gnuradio.digital.packet_utils.make_header -.. autofunction:: gnuradio.digital.packet_utils.make_packet -.. autofunction:: gnuradio.digital.packet_utils.unmake_packet -.. autofunction:: gnuradio.digital.psk_2_0x0 -.. autofunction:: gnuradio.digital.psk_2_0x1 -.. autofunction:: gnuradio.digital.sd_psk_2_0x0 -.. autofunction:: gnuradio.digital.sd_psk_2_0x1 -.. autofunction:: gnuradio.digital.psk_4_0x0_0_1 -.. autofunction:: gnuradio.digital.psk_4_0x1_0_1 -.. autofunction:: gnuradio.digital.psk_4_0x2_0_1 -.. autofunction:: gnuradio.digital.psk_4_0x3_0_1 -.. autofunction:: gnuradio.digital.psk_4_0x0_1_0 -.. autofunction:: gnuradio.digital.psk_4_0x1_1_0 -.. autofunction:: gnuradio.digital.psk_4_0x2_1_0 -.. autofunction:: gnuradio.digital.psk_4_0x3_1_0 -.. autofunction:: gnuradio.digital.sd_psk_4_0x0_0_1 -.. autofunction:: gnuradio.digital.sd_psk_4_0x1_0_1 -.. autofunction:: gnuradio.digital.sd_psk_4_0x2_0_1 -.. autofunction:: gnuradio.digital.sd_psk_4_0x3_0_1 -.. autofunction:: gnuradio.digital.sd_psk_4_0x0_1_0 -.. autofunction:: gnuradio.digital.sd_psk_4_0x1_1_0 -.. autofunction:: gnuradio.digital.sd_psk_4_0x2_1_0 -.. autofunction:: gnuradio.digital.sd_psk_4_0x3_1_0 -.. autofunction:: gnuradio.digital.psk_constellation -.. autofunction:: gnuradio.digital.qam_16_0x0_0_1_2_3 -.. autofunction:: gnuradio.digital.qam_16_0x1_0_1_2_3 -.. autofunction:: gnuradio.digital.qam_16_0x2_0_1_2_3 -.. autofunction:: gnuradio.digital.qam_16_0x3_0_1_2_3 -.. autofunction:: gnuradio.digital.qam_16_0x0_1_0_2_3 -.. autofunction:: gnuradio.digital.qam_16_0x1_1_0_2_3 -.. autofunction:: gnuradio.digital.qam_16_0x2_1_0_2_3 -.. autofunction:: gnuradio.digital.qam_16_0x3_1_0_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x0_0_1_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x1_0_1_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x2_0_1_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x3_0_1_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x0_1_0_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x1_1_0_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x2_1_0_2_3 -.. autofunction:: gnuradio.digital.sd_qam_16_0x3_1_0_2_3 -.. autofunction:: gnuradio.digital.qam32_holeinside_constellation -.. autofunction:: gnuradio.digital.make_differential_constellation -.. autofunction:: gnuradio.digital.make_non_differential_constellation -.. autofunction:: gnuradio.digital.qam_constellation -.. autofunction:: gnuradio.digital.qpsk_constellation -.. autofunction:: gnuradio.digital.dqpsk_constellation -.. autofunction:: gnuradio.digital.soft_dec_table_generator -.. autofunction:: gnuradio.digital.soft_dec_table -.. autofunction:: gnuradio.digital.calc_soft_dec_from_table -.. autofunction:: gnuradio.digital.calc_soft_dec -.. autofunction:: gnuradio.digital.show_table diff --git a/docs/sphinx/source/digital_blocks.rst b/docs/sphinx/source/digital_blocks.rst deleted file mode 100644 index faee4c179c..0000000000 --- a/docs/sphinx/source/digital_blocks.rst +++ /dev/null @@ -1,74 +0,0 @@ -gnuradio.digital -================= - -.. automodule:: gnuradio.digital - -.. autoblock:: gnuradio.digital.additive_scrambler_bb -.. autoblock:: gnuradio.digital.binary_slicer_fb -.. autoblock:: gnuradio.digital.burst_shaper_cc -.. autoblock:: gnuradio.digital.burst_shaper_ff -.. autoblock:: gnuradio.digital.chunks_to_symbols_bc -.. autoblock:: gnuradio.digital.chunks_to_symbols_bf -.. autoblock:: gnuradio.digital.chunks_to_symbols_ic -.. autoblock:: gnuradio.digital.chunks_to_symbols_if -.. autoblock:: gnuradio.digital.chunks_to_symbols_sc -.. autoblock:: gnuradio.digital.chunks_to_symbols_sf -.. autoblock:: gnuradio.digital.clock_recovery_mm_cc -.. autoblock:: gnuradio.digital.clock_recovery_mm_ff -.. autoblock:: gnuradio.digital.cma_equalizer_cc -.. autoblock:: gnuradio.digital.constellation_decoder_cb -.. autoblock:: gnuradio.digital.constellation_receiver_cb -.. autoblock:: gnuradio.digital.constellation_soft_decoder_cf -.. autoblock:: gnuradio.digital.correlate_access_code_bb -.. autoblock:: gnuradio.digital.correlate_access_code_bb_ts -.. autoblock:: gnuradio.digital.correlate_access_code_ff_ts -.. autoblock:: gnuradio.digital.correlate_access_code_tag_bb -.. autoblock:: gnuradio.digital.correlate_and_sync_cc -.. autoblock:: gnuradio.digital.corr_est_cc -.. autoblock:: gnuradio.digital.costas_loop_cc -.. autoblock:: gnuradio.digital.cpmmod_bc -.. autoblock:: gnuradio.digital.crc32_async_bb -.. autoblock:: gnuradio.digital.crc32_bb -.. autoblock:: gnuradio.digital.descrambler_bb -.. autoblock:: gnuradio.digital.diff_decoder_bb -.. autoblock:: gnuradio.digital.diff_encoder_bb -.. autoblock:: gnuradio.digital.diff_phasor_cc -.. autoblock:: gnuradio.digital.fll_band_edge_cc -.. autoblock:: gnuradio.digital.framer_sink_1 -.. autoblock:: gnuradio.digital.glfsr_source_b -.. autoblock:: gnuradio.digital.glfsr_source_f -.. autoblock:: gnuradio.digital.hdlc_deframer_bp -.. autoblock:: gnuradio.digital.hdlc_framer_pb -.. autoblock:: gnuradio.digital.header_payload_demux -.. autoblock:: gnuradio.digital.kurtotic_equalizer_cc -.. autoblock:: gnuradio.digital.lms_dd_equalizer_cc -.. autoblock:: gnuradio.digital.map_bb -.. autoblock:: gnuradio.digital.mpsk_snr_est_cc -.. autoblock:: gnuradio.digital.msk_timing_recovery_cc -.. autoblock:: gnuradio.digital.ofdm_carrier_allocator_cvc -.. autoblock:: gnuradio.digital.ofdm_chanest_vcvc -.. autoblock:: gnuradio.digital.ofdm_cyclic_prefixer -.. autoblock:: gnuradio.digital.ofdm_equalizer_base -.. autoblock:: gnuradio.digital.ofdm_equalizer_simpledfe -.. autoblock:: gnuradio.digital.ofdm_equalizer_static -.. autoblock:: gnuradio.digital.ofdm_frame_acquisition -.. autoblock:: gnuradio.digital.ofdm_frame_equalizer_vcvc -.. autoblock:: gnuradio.digital.ofdm_frame_sink -.. autoblock:: gnuradio.digital.ofdm_insert_preamble -.. autoblock:: gnuradio.digital.ofdm_mapper_bcv -.. autoblock:: gnuradio.digital.ofdm_sampler -.. autoblock:: gnuradio.digital.ofdm_serializer_vcc -.. autoblock:: gnuradio.digital.ofdm_sync_sc_cfb -.. autoblock:: gnuradio.digital.packet_header_default -.. autoblock:: gnuradio.digital.packet_headergenerator_bb -.. autoblock:: gnuradio.digital.packet_header_ofdm -.. autoblock:: gnuradio.digital.packet_headerparser_b -.. autoblock:: gnuradio.digital.packet_sink -.. autoblock:: gnuradio.digital.pfb_clock_sync_ccf -.. autoblock:: gnuradio.digital.pfb_clock_sync_fff -.. autoblock:: gnuradio.digital.pn_correlator_cc -.. autoblock:: gnuradio.digital.probe_density_b -.. autoblock:: gnuradio.digital.probe_mpsk_snr_est_c -.. autoblock:: gnuradio.digital.scrambler_bb -.. autoblock:: gnuradio.digital.simple_correlator -.. autoblock:: gnuradio.digital.simple_framer diff --git a/docs/sphinx/source/dtv.rst b/docs/sphinx/source/dtv.rst deleted file mode 100644 index 0cf9a50928..0000000000 --- a/docs/sphinx/source/dtv.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.dtv -============ - -.. automodule:: gnuradio.dtv diff --git a/docs/sphinx/source/dtv_blocks.rst b/docs/sphinx/source/dtv_blocks.rst deleted file mode 100644 index d20f0d075d..0000000000 --- a/docs/sphinx/source/dtv_blocks.rst +++ /dev/null @@ -1,44 +0,0 @@ -gnuradio.dtv -============ - -.. automodule:: gnuradio.dtv - -.. autoblock:: gnuradio.dtv.atsc_deinterleaver -.. autoblock:: gnuradio.dtv.atsc_depad -.. autoblock:: gnuradio.dtv.atsc_derandomizer -.. autoblock:: gnuradio.dtv.atsc_equalizer -.. autoblock:: gnuradio.dtv.atsc_field_sync_mux -.. autoblock:: gnuradio.dtv.atsc_fpll -.. autoblock:: gnuradio.dtv.atsc_fs_checker -.. autoblock:: gnuradio.dtv.atsc_interleaver -.. autoblock:: gnuradio.dtv.atsc_pad -.. autoblock:: gnuradio.dtv.atsc_randomizer -.. autoblock:: gnuradio.dtv.atsc_rs_decoder -.. autoblock:: gnuradio.dtv.atsc_rs_encoder -.. autoblock:: gnuradio.dtv.atsc_sync -.. autoblock:: gnuradio.dtv.atsc_trellis_encoder -.. autoblock:: gnuradio.dtv.atsc_viterbi_decoder -.. autoblock:: gnuradio.dtv.dvb_bbheader_bb -.. autoblock:: gnuradio.dtv.dvb_bbscrambler_bb -.. autoblock:: gnuradio.dtv.dvb_bch_bb -.. autoblock:: gnuradio.dtv.dvb_ldpc_bb -.. autoblock:: gnuradio.dtv.dvbs2_interleaver_bb -.. autoblock:: gnuradio.dtv.dvbs2_modulator_bc -.. autoblock:: gnuradio.dtv.dvbs2_physical_cc -.. autoblock:: gnuradio.dtv.dvbt2_cellinterleaver_cc -.. autoblock:: gnuradio.dtv.dvbt2_framemapper_cc -.. autoblock:: gnuradio.dtv.dvbt2_freqinterleaver_cc -.. autoblock:: gnuradio.dtv.dvbt2_interleaver_bb -.. autoblock:: gnuradio.dtv.dvbt2_miso_cc -.. autoblock:: gnuradio.dtv.dvbt2_modulator_bc -.. autoblock:: gnuradio.dtv.dvbt2_p1insertion_cc -.. autoblock:: gnuradio.dtv.dvbt2_paprtr_cc -.. autoblock:: gnuradio.dtv.dvbt2_pilotgenerator_cc -.. autoblock:: gnuradio.dtv.dvbt_bit_inner_interleaver -.. autoblock:: gnuradio.dtv.dvbt_convolutional_interleaver -.. autoblock:: gnuradio.dtv.dvbt_energy_dispersal -.. autoblock:: gnuradio.dtv.dvbt_inner_coder -.. autoblock:: gnuradio.dtv.dvbt_map -.. autoblock:: gnuradio.dtv.dvbt_reed_solomon_enc -.. autoblock:: gnuradio.dtv.dvbt_reference_signals -.. autoblock:: gnuradio.dtv.dvbt_symbol_inner_interleaver diff --git a/docs/sphinx/source/fec.rst b/docs/sphinx/source/fec.rst deleted file mode 100644 index c8990c45ee..0000000000 --- a/docs/sphinx/source/fec.rst +++ /dev/null @@ -1,31 +0,0 @@ -gnuradio.fec -============ - -.. autoclass:: gnuradio.fec.cc_decoder -.. autoclass:: gnuradio.fec.cc_encoder -.. autoclass:: gnuradio.fec.ccsds_encoder -.. autoclass:: gnuradio.fec.dummy_decoder -.. autoclass:: gnuradio.fec.dummy_encoder -.. autoclass:: gnuradio.fec.ldpc_decoder -.. autoclass:: gnuradio.fec.ldpc_encoder -.. autoclass:: gnuradio.fec.repetition_decoder -.. autoclass:: gnuradio.fec.repetition_encoder -.. autoclass:: gnuradio.fec.tpc_decoder -.. autoclass:: gnuradio.fec.tpc_encoder - -.. autoclass:: gnuradio.fec.bercurve_generator -.. autofunction:: gnuradio.fec.bitreverse -.. autofunction:: gnuradio.fec.bitflip -.. autofunction:: gnuradio.fec.read_bitlist -.. autofunction:: gnuradio.fec.read_big_bitlist -.. autofunction:: gnuradio.fec.generate_symmetries -.. autoclass:: gnuradio.fec.capillary_threaded_decoder -.. autoclass:: gnuradio.fec.capillary_threaded_encoder -.. autoclass:: gnuradio.fec.extended_async_encoder -.. autoclass:: gnuradio.fec.extended_decoder -.. autoclass:: gnuradio.fec.extended_encoder -.. autoclass:: gnuradio.fec.extended_tagged_decoder -.. autoclass:: gnuradio.fec.extended_tagged_encoder -.. autoclass:: gnuradio.fec.fec_test -.. autoclass:: gnuradio.fec.threaded_decoder -.. autoclass:: gnuradio.fec.threaded_encoder diff --git a/docs/sphinx/source/fec_blocks.rst b/docs/sphinx/source/fec_blocks.rst deleted file mode 100644 index 6e92a86a41..0000000000 --- a/docs/sphinx/source/fec_blocks.rst +++ /dev/null @@ -1,20 +0,0 @@ -gnuradio.fec -============ - -.. automodule:: gnuradio.fec - -.. autoblock:: gnuradio.fec.async_decoder -.. autoblock:: gnuradio.fec.async_encoder -.. autoblock:: gnuradio.fec.ber_bf -.. autoblock:: gnuradio.fec.conv_bit_corr_bb -.. autoblock:: gnuradio.fec.decode_ccsds_27_fb -.. autoblock:: gnuradio.fec.decoder -.. autoblock:: gnuradio.fec.depuncture_bb -.. autoblock:: gnuradio.fec.encode_ccsds_27_bb -.. autoblock:: gnuradio.fec.encoder -.. autoblock:: gnuradio.fec.generic_decoder -.. autoblock:: gnuradio.fec.generic_encoder -.. autoblock:: gnuradio.fec.puncture_bb -.. autoblock:: gnuradio.fec.puncture_ff -.. autoblock:: gnuradio.fec.tagged_decoder -.. autoblock:: gnuradio.fec.tagged_encoder diff --git a/docs/sphinx/source/fft.rst b/docs/sphinx/source/fft.rst deleted file mode 100644 index 563a5c898f..0000000000 --- a/docs/sphinx/source/fft.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.fft -============ - -.. autoclass:: gnuradio.fft.window diff --git a/docs/sphinx/source/fft_blocks.rst b/docs/sphinx/source/fft_blocks.rst deleted file mode 100644 index 3b226a20ba..0000000000 --- a/docs/sphinx/source/fft_blocks.rst +++ /dev/null @@ -1,9 +0,0 @@ -gnuradio.fft -============ - -.. automodule:: gnuradio.fft - -.. autoblock:: gnuradio.fft.ctrlport_probe_psd -.. autoblock:: gnuradio.fft.fft_vcc -.. autoblock:: gnuradio.fft.fft_vfc -.. autoblock:: gnuradio.fft.goertzel_fc diff --git a/docs/sphinx/source/filter.rst b/docs/sphinx/source/filter.rst deleted file mode 100644 index d9f2d9207a..0000000000 --- a/docs/sphinx/source/filter.rst +++ /dev/null @@ -1,29 +0,0 @@ -gnuradio.filter -=============== - -.. autoclass:: gnuradio.filter.filterbank.analysis_filterbank -.. autoclass:: gnuradio.filter.filterbank.synthesis_filterbank -.. autoclass:: gnuradio.filter.firdes -.. autofunction:: gnuradio.filter.pm_remez -.. autoclass:: gnuradio.filter.synthesis_filterbank -.. autoclass:: gnuradio.filter.analysis_filterbank -.. autoclass:: gnuradio.filter.freq_xlating_fft_filter_ccc -.. autofunction:: gnuradio.filter.optfir.low_pass -.. autofunction:: gnuradio.filter.optfir.band_pass -.. autofunction:: gnuradio.filter.optfir.complex_band_pass -.. autofunction:: gnuradio.filter.optfir.band_reject -.. autofunction:: gnuradio.filter.optfir.stopband_atten_to_dev -.. autofunction:: gnuradio.filter.optfir.passband_ripple_to_dev -.. autofunction:: gnuradio.filter.optfir.remezord -.. autofunction:: gnuradio.filter.optfir.lporder -.. autofunction:: gnuradio.filter.optfir.bporder -.. autoclass:: gnuradio.filter.pfb.channelizer_ccf -.. autoclass:: gnuradio.filter.pfb.interpolator_ccf -.. autoclass:: gnuradio.filter.pfb.decimator_ccf -.. autoclass:: gnuradio.filter.pfb.arb_resampler_ccf -.. autoclass:: gnuradio.filter.pfb.arb_resampler_fff -.. autoclass:: gnuradio.filter.pfb.arb_resampler_ccc -.. autoclass:: gnuradio.filter.pfb.channelizer_hier_ccf -.. autoclass:: gnuradio.filter.rational_resampler_fff -.. autoclass:: gnuradio.filter.rational_resampler_ccf -.. autoclass:: gnuradio.filter.rational_resampler_ccc diff --git a/docs/sphinx/source/filter_blocks.rst b/docs/sphinx/source/filter_blocks.rst deleted file mode 100644 index 50eee7db58..0000000000 --- a/docs/sphinx/source/filter_blocks.rst +++ /dev/null @@ -1,55 +0,0 @@ -gnuradio.filters -================ - -.. automodule:: gnuradio.filter - -.. autoblock:: gnuradio.filter.dc_blocker_cc -.. autoblock:: gnuradio.filter.dc_blocker_ff -.. autoblock:: gnuradio.filter.fft_filter_ccc -.. autoblock:: gnuradio.filter.fft_filter_ccf -.. autoblock:: gnuradio.filter.fft_filter_fff -.. autoblock:: gnuradio.filter.filter_delay_fc -.. autoblock:: gnuradio.filter.filterbank_vcvcf -.. autoblock:: gnuradio.filter.fir_filter_ccc -.. autoblock:: gnuradio.filter.fir_filter_ccf -.. autoblock:: gnuradio.filter.fir_filter_fcc -.. autoblock:: gnuradio.filter.fir_filter_fff -.. autoblock:: gnuradio.filter.fir_filter_fsf -.. autoblock:: gnuradio.filter.fir_filter_scc -.. autoblock:: gnuradio.filter.mmse_interpolator_cc -.. autoblock:: gnuradio.filter.mmse_interpolator_ff -.. autoblock:: gnuradio.filter.mmse_resampler_cc -.. autoblock:: gnuradio.filter.mmse_resampler_ff -.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_ccc -.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_ccf -.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_fcc -.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_fcf -.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_scc -.. autoblock:: gnuradio.filter.freq_xlating_fir_filter_scf -.. autoblock:: gnuradio.filter.hilbert_fc -.. autoblock:: gnuradio.filter.iir_filter_ccc -.. autoblock:: gnuradio.filter.iir_filter_ccd -.. autoblock:: gnuradio.filter.iir_filter_ccf -.. autoblock:: gnuradio.filter.iir_filter_ccz -.. autoblock:: gnuradio.filter.iir_filter_ffd -.. autoblock:: gnuradio.filter.interp_fir_filter_ccc -.. autoblock:: gnuradio.filter.interp_fir_filter_ccf -.. autoblock:: gnuradio.filter.interp_fir_filter_fcc -.. autoblock:: gnuradio.filter.interp_fir_filter_fff -.. autoblock:: gnuradio.filter.interp_fir_filter_fsf -.. autoblock:: gnuradio.filter.interp_fir_filter_scc -.. autoblock:: gnuradio.filter.pfb_arb_resampler_ccc -.. autoblock:: gnuradio.filter.pfb_arb_resampler_ccf -.. autoblock:: gnuradio.filter.pfb_arb_resampler_fff -.. autoblock:: gnuradio.filter.pfb_channelizer_ccf -.. autoblock:: gnuradio.filter.pfb_decimator_ccf -.. autoblock:: gnuradio.filter.pfb_interpolator_ccf -.. autoblock:: gnuradio.filter.pfb_synthesizer_ccf -.. autoblock:: gnuradio.filter.rational_resampler_base_ccc -.. autoblock:: gnuradio.filter.rational_resampler_base_ccf -.. autoblock:: gnuradio.filter.rational_resampler_base_fcc -.. autoblock:: gnuradio.filter.rational_resampler_base_fff -.. autoblock:: gnuradio.filter.rational_resampler_base_fsf -.. autoblock:: gnuradio.filter.rational_resampler_base_scc -.. autoblock:: gnuradio.filter.single_pole_iir_filter_cc -.. autoblock:: gnuradio.filter.single_pole_iir_filter_ff diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst deleted file mode 100644 index fb74a22ca9..0000000000 --- a/docs/sphinx/source/index.rst +++ /dev/null @@ -1,1403 +0,0 @@ -gnuradio -======== - -.. toctree:: - :hidden: - - runtime <runtime> - pmt <pmt> - blocks_audio <audio_blocks> - blocks_analog <analog_blocks> - blocks_blocks <blocks_blocks> - blocks_channels <channels_blocks> - blocks_digital <digital_blocks> - blocks_dtv <dtv_blocks> - blocks_fec <fec_blocks> - blocks_fft <fft_blocks> - blocks_filter <filter_blocks> - blocks_qtgui <qtgui_blocks> - blocks_trellis <trellis_blocks> - blocks_uhd <uhd_blocks> - blocks_video_sdl <video_sdl_blocks> - blocks_vocoder <vocoder_blocks> - blocks_wavelet <wavelet_blocks> - blocks_zeromq <zeromq_blocks> - analog <analog> - channels <channels> - digital <digital> - dtv <dtv> - fec <fec> - fft <fft> - filter <filter> - trellis <trellis> - uhd <uhd> - vocoder <vocoder> - -.. automodule:: gnuradio -.. automodule:: pmt - -Runtime -------- - -.. autosummary:: - :nosignatures: - - gnuradio.gr.top_block - gnuradio.gr.basic_block - gnuradio.gr.block - gnuradio.gr.sync_block - gnuradio.gr.sync_decimator - gnuradio.gr.sync_interpolator - gnuradio.gr.tagged_stream_block - gnuradio.gr.hier_block2 - gnuradio.gr.high_res_timer_now - gnuradio.gr.high_res_timer_now_perfmon - gnuradio.gr.high_res_timer_epoch - gnuradio.gr.high_res_timer_tps - gnuradio.gr.io_signature - gnuradio.gr.io_signature2 - gnuradio.gr.io_signature3 - gnuradio.gr.io_signaturev - gnuradio.gr.prefix - gnuradio.gr.prefsdir - gnuradio.gr.sysconfdir - gnuradio.gr.version - gnuradio.gr.major_version - gnuradio.gr.api_version - gnuradio.gr.minor_version - gnuradio.gr.prefs - gnuradio.gr.logger - gnuradio.gr.logger_config - gnuradio.gr.logger_get_names - gnuradio.gr.logger_reset_config - gnuradio.gr.tag_t - gnuradio.gr.tag_t_offset_compare - gnuradio.gr.tag_t_offset_compare_key - gnuradio.gr.tag_to_pmt - gnuradio.gr.tag_to_python - gnuradio.gr.tag_utils - gnuradio.gr.sizeof_gr_complex - gnuradio.gr.sizeof_float - gnuradio.gr.sizeof_int - gnuradio.gr.sizeof_short - gnuradio.gr.sizeof_char - gnuradio.gr.sizeof_double - gnuradio.gr.branchless_binary_slicer - gnuradio.gr.binary_slicer - gnuradio.gr.branchless_clip - gnuradio.gr.clip - gnuradio.gr.branchless_quad_0deg_slicer - gnuradio.gr.quad_0deg_slicer - gnuradio.gr.branchless_quad_45deg_slicer - gnuradio.gr.quad_45deg_slicer - gnuradio.gr.feval - gnuradio.gr.feval_cc - gnuradio.gr.feval_dd - gnuradio.gr.feval_ll - gnuradio.gr.feval_p - gnuradio.gr.gateway - - -PMT ---- - -.. autosummary:: - :nosignatures: - - pmt.acons - pmt.any_ref - pmt.any_set - pmt.assoc - pmt.assq - pmt.assv - pmt.blob_data - pmt.blob_length - pmt.c32vector_elements - pmt.c32vector_ref - pmt.c32vector_set - pmt.c64vector_elements - pmt.c64vector_ref - pmt.c64vector_set - pmt.caar - pmt.cadddr - pmt.caddr - pmt.cadr - pmt.car - pmt.cdar - pmt.cddr - pmt.cdr - pmt.cons - pmt.deserialize - pmt.deserialize_str - pmt.dict_add - pmt.dict_delete - pmt.dict_has_key - pmt.dict_items - pmt.dict_keys - pmt.dict_ref - pmt.dict_update - pmt.dict_values - pmt.dump_sizeof - pmt.eq - pmt.equal - pmt.eqv - pmt.f32vector_elements - pmt.f32vector_ref - pmt.f32vector_set - pmt.f64vector_elements - pmt.f64vector_ref - pmt.f64vector_set - pmt.from_bool - pmt.from_complex - pmt.from_double - pmt.from_float - pmt.from_long - pmt.from_uint64 - pmt.get_PMT_EOF - pmt.get_PMT_F - pmt.get_PMT_NIL - pmt.get_PMT_T - 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.intern - 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 - 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_c32vector - pmt.make_c64vector - pmt.make_dict - pmt.make_f32vector - pmt.make_f64vector - pmt.make_msg_accepter - pmt.make_rectangular - pmt.make_s16vector - pmt.make_s32vector - pmt.make_s64vector - pmt.make_s8vector - pmt.make_tuple - pmt.make_u16vector - pmt.make_u32vector - pmt.make_u64vector - pmt.make_u8vector - pmt.make_vector - pmt.map - pmt.member - pmt.memq - pmt.memv - pmt.msg_accepter_ref - pmt.nth - pmt.nthcdr - pmt.pmt_vector_cdouble - pmt.pmt_vector_cfloat - pmt.pmt_vector_double - pmt.pmt_vector_float - pmt.pmt_vector_int16 - pmt.pmt_vector_int32 - pmt.pmt_vector_int8 - pmt.pmt_vector_uint16 - pmt.pmt_vector_uint32 - pmt.pmt_vector_uint8 - pmt.read - pmt.reverse - pmt.reverse_x - pmt.s16vector_elements - pmt.s16vector_ref - pmt.s16vector_set - pmt.s32vector_elements - pmt.s32vector_ref - pmt.s32vector_set - pmt.s64vector_ref - pmt.s64vector_set - pmt.s8vector_elements - pmt.s8vector_ref - pmt.s8vector_set - pmt.serialize - pmt.serialize_str - pmt.set_car - pmt.set_cdr - pmt.string_to_symbol - pmt.subsetp - pmt.symbol_to_string - pmt.to_bool - pmt.to_complex - pmt.to_double - pmt.to_float - pmt.to_long - pmt.to_pmt - pmt.to_python - pmt.to_tuple - pmt.to_uint64 - pmt.tuple_ref - pmt.u16vector_elements - pmt.u16vector_ref - pmt.u16vector_set - pmt.u32vector_elements - pmt.u32vector_ref - pmt.u32vector_set - pmt.u64vector_ref - pmt.u64vector_set - pmt.u8vector_elements - pmt.u8vector_ref - pmt.u8vector_set - pmt.uniform_vector_elements - pmt.uniform_vector_itemsize - pmt.vector_fill - pmt.vector_ref - pmt.vector_set - pmt.write - pmt.write_string - - -Audio Signals -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.audio.sink - gnuradio.audio.source - gnuradio.vocoder.alaw_decode_bs - gnuradio.vocoder.alaw_encode_sb - gnuradio.vocoder.codec2_decode_ps - gnuradio.vocoder.codec2_encode_sp - gnuradio.vocoder.cvsd_decode_bs - gnuradio.vocoder.cvsd_encode_sb - gnuradio.vocoder.g721_decode_bs - gnuradio.vocoder.g721_encode_sb - gnuradio.vocoder.g723_24_decode_bs - gnuradio.vocoder.g723_24_encode_sb - gnuradio.vocoder.g723_40_decode_bs - gnuradio.vocoder.g723_40_encode_sb - gnuradio.vocoder.gsm_fr_decode_ps - gnuradio.vocoder.gsm_fr_encode_sp - gnuradio.vocoder.ulaw_decode_bs - gnuradio.vocoder.ulaw_encode_sb - gnuradio.blocks.wavfile_sink - gnuradio.blocks.wavfile_source - -Boolean Operators ------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.and_bb - gnuradio.blocks.and_const_bb - gnuradio.blocks.and_const_ii - gnuradio.blocks.and_const_ss - gnuradio.blocks.and_ii - gnuradio.blocks.and_ss - gnuradio.blocks.not_bb - gnuradio.blocks.not_ii - gnuradio.blocks.not_ss - gnuradio.blocks.or_bb - gnuradio.blocks.or_ii - gnuradio.blocks.or_ss - gnuradio.blocks.xor_bb - gnuradio.blocks.xor_ii - gnuradio.blocks.xor_ss - -Byte Operators --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.packed_to_unpacked_bb - gnuradio.blocks.packed_to_unpacked_ii - gnuradio.blocks.packed_to_unpacked_ss - gnuradio.blocks.unpacked_to_packed_bb - gnuradio.blocks.unpacked_to_packed_ii - gnuradio.blocks.unpacked_to_packed_ss - gnuradio.blocks.pack_k_bits_bb - gnuradio.blocks.repack_bits_bb - gnuradio.blocks.unpack_k_bits_bb - -Channelizers ------------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.freq_xlating_fir_filter_ccc - gnuradio.filter.freq_xlating_fir_filter_ccf - gnuradio.filter.freq_xlating_fir_filter_fcc - gnuradio.filter.freq_xlating_fir_filter_fcf - gnuradio.filter.freq_xlating_fir_filter_scc - gnuradio.filter.freq_xlating_fir_filter_scf - gnuradio.filter.pfb_channelizer_ccf - gnuradio.filter.pfb_decimator_ccf - gnuradio.filter.pfb_interpolator_ccf - gnuradio.filter.pfb_synthesizer_ccf - -Channel Models --------------- - -.. autosummary:: - :nosignatures: - - gnuradio.channels.channel_model - gnuradio.channels.channel_model2 - gnuradio.channels.fading_model - gnuradio.channels.selective_fading_model - gnuradio.channels.dynamic_channel_model - gnuradio.channels.cfo_model - gnuradio.channels.sro_model - - -Coding Blocks -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.additive_scrambler_bb - gnuradio.digital.descrambler_bb - gnuradio.digital.scrambler_bb - - -ControlPort Blocks ------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.ctrlport_probe2_b - gnuradio.blocks.ctrlport_probe2_c - gnuradio.blocks.ctrlport_probe2_f - gnuradio.blocks.ctrlport_probe2_i - gnuradio.blocks.ctrlport_probe2_s - gnuradio.blocks.ctrlport_probe_c - gnuradio.fft.ctrlport_probe_psd - - -Debug Blocks ------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.message_debug - gnuradio.blocks.message_strobe - gnuradio.blocks.message_strobe_random - gnuradio.blocks.tag_debug - gnuradio.blocks.tags_strobe - gnuradio.blocks.vector_sink_b - gnuradio.blocks.vector_sink_c - gnuradio.blocks.vector_sink_f - gnuradio.blocks.vector_sink_i - gnuradio.blocks.vector_sink_s - gnuradio.blocks.random_pdu - - -DTV Blocks ------------- - -.. autosummary:: - :nosignatures: - - gnuradio.dtv.atsc_deinterleaver - gnuradio.dtv.atsc_depad - gnuradio.dtv.atsc_derandomizer - gnuradio.dtv.atsc_equalizer - gnuradio.dtv.atsc_field_sync_mux - gnuradio.dtv.atsc_fpll - gnuradio.dtv.atsc_fs_checker - gnuradio.dtv.atsc_interleaver - gnuradio.dtv.atsc_pad - gnuradio.dtv.atsc_randomizer - gnuradio.dtv.atsc_rs_decoder - gnuradio.dtv.atsc_rs_encoder - gnuradio.dtv.atsc_sync - gnuradio.dtv.atsc_trellis_encoder - gnuradio.dtv.atsc_viterbi_decoder - gnuradio.dtv.dvb_bbheader_bb - gnuradio.dtv.dvb_bbscrambler_bb - gnuradio.dtv.dvb_bch_bb - gnuradio.dtv.dvb_ldpc_bb - gnuradio.dtv.dvbs2_interleaver_bb - gnuradio.dtv.dvbs2_modulator_bc - gnuradio.dtv.dvbs2_physical_cc - gnuradio.dtv.dvbt2_cellinterleaver_cc - gnuradio.dtv.dvbt2_framemapper_cc - gnuradio.dtv.dvbt2_freqinterleaver_cc - gnuradio.dtv.dvbt2_interleaver_bb - gnuradio.dtv.dvbt2_miso_cc - gnuradio.dtv.dvbt2_modulator_bc - gnuradio.dtv.dvbt2_p1insertion_cc - gnuradio.dtv.dvbt2_paprtr_cc - gnuradio.dtv.dvbt2_pilotgenerator_cc - gnuradio.dtv.dvbt_bit_inner_interleaver - gnuradio.dtv.dvbt_convolutional_interleaver - gnuradio.dtv.dvbt_energy_dispersal - gnuradio.dtv.dvbt_inner_coder - gnuradio.dtv.dvbt_map - gnuradio.dtv.dvbt_reed_solomon_enc - gnuradio.dtv.dvbt_reference_signals - gnuradio.dtv.dvbt_symbol_inner_interleaver - - -Equalizer Blocks ----------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.cma_equalizer_cc - gnuradio.digital.lms_dd_equalizer_cc - gnuradio.digital.kurtotic_equalizer_cc - -Error Coding Blocks -------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.fec.async_decoder - gnuradio.fec.async_encoder - gnuradio.fec.ber_bf - gnuradio.fec.conv_bit_corr_bb - gnuradio.fec.decode_ccsds_27_fb - gnuradio.fec.decoder - gnuradio.fec.depuncture_bb - gnuradio.fec.encode_ccsds_27_bb - gnuradio.fec.encoder - gnuradio.fec.generic_decoder - gnuradio.fec.generic_encoder - gnuradio.fec.puncture_bb - gnuradio.fec.puncture_ff - gnuradio.fec.tagged_decoder - gnuradio.fec.tagged_encoder - - -File Operator Blocks --------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.file_descriptor_sink - gnuradio.blocks.file_descriptor_source - gnuradio.blocks.file_meta_sink - gnuradio.blocks.file_meta_source - gnuradio.blocks.file_sink - gnuradio.blocks.file_source - gnuradio.blocks.tagged_file_sink - - -Filter Blocks -------------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.dc_blocker_cc - gnuradio.filter.dc_blocker_ff - gnuradio.filter.fft_filter_ccc - gnuradio.filter.fft_filter_ccf - gnuradio.filter.fft_filter_fff - gnuradio.filter.filter_delay_fc - gnuradio.filter.filterbank_vcvcf - gnuradio.filter.fir_filter_ccc - gnuradio.filter.fir_filter_ccf - gnuradio.filter.fir_filter_fcc - gnuradio.filter.fir_filter_fff - gnuradio.filter.fir_filter_fsf - gnuradio.filter.fir_filter_scc - gnuradio.filter.mmse_interpolator_cc - gnuradio.filter.mmse_interpolator_ff - gnuradio.filter.mmse_resampler_cc - gnuradio.filter.mmse_resampler_ff - gnuradio.filter.freq_xlating_fir_filter_ccc - gnuradio.filter.freq_xlating_fir_filter_ccf - gnuradio.filter.freq_xlating_fir_filter_fcc - gnuradio.filter.freq_xlating_fir_filter_fcf - gnuradio.filter.freq_xlating_fir_filter_scc - gnuradio.filter.freq_xlating_fir_filter_scf - gnuradio.filter.hilbert_fc - gnuradio.filter.iir_filter_ccc - gnuradio.filter.iir_filter_ccd - gnuradio.filter.iir_filter_ccf - gnuradio.filter.iir_filter_ccz - gnuradio.filter.iir_filter_ffd - gnuradio.filter.interp_fir_filter_ccc - gnuradio.filter.interp_fir_filter_ccf - gnuradio.filter.interp_fir_filter_fcc - gnuradio.filter.interp_fir_filter_fff - gnuradio.filter.interp_fir_filter_fsf - gnuradio.filter.interp_fir_filter_scc - gnuradio.filter.pfb_arb_resampler_ccc - gnuradio.filter.pfb_arb_resampler_ccf - gnuradio.filter.pfb_arb_resampler_fff - gnuradio.filter.pfb_channelizer_ccf - gnuradio.filter.pfb_decimator_ccf - gnuradio.filter.pfb_interpolator_ccf - gnuradio.filter.pfb_synthesizer_ccf - gnuradio.filter.rational_resampler_base_ccc - gnuradio.filter.rational_resampler_base_ccf - gnuradio.filter.rational_resampler_base_fcc - gnuradio.filter.rational_resampler_base_fff - gnuradio.filter.rational_resampler_base_fsf - gnuradio.filter.rational_resampler_base_scc - gnuradio.filter.single_pole_iir_filter_cc - gnuradio.filter.single_pole_iir_filter_ff - - - -Fourier Analysis ----------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.fft.fft_vcc - gnuradio.fft.fft_vfc - gnuradio.fft.goertzel_fc - - -Impairment Model Blocks ------------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.channels.amp_bal - gnuradio.channels.conj_fs_iqcorr - gnuradio.channels.distortion_2_gen - gnuradio.channels.distortion_3_gen - gnuradio.channels.impairments - gnuradio.channels.iqbal_gen - gnuradio.channels.phase_bal - gnuradio.channels.phase_noise_gen - gnuradio.channels.quantizer - - -Instrumentation Blocks ----------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.qtgui.ber_sink_b - gnuradio.qtgui.const_sink_c - gnuradio.qtgui.freq_sink_c - gnuradio.qtgui.freq_sink_f - gnuradio.qtgui.histogram_sink_f - gnuradio.qtgui.number_sink - gnuradio.qtgui.sink_c - gnuradio.qtgui.sink_f - gnuradio.qtgui.time_raster_sink_b - gnuradio.qtgui.time_raster_sink_f - gnuradio.qtgui.time_sink_c - gnuradio.qtgui.time_sink_f - gnuradio.qtgui.vector_sink_f - gnuradio.qtgui.waterfall_sink_c - gnuradio.qtgui.waterfall_sink_f - - - -Level Control Blocks --------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.agc2_cc - gnuradio.analog.agc2_ff - gnuradio.analog.agc3_cc - gnuradio.analog.agc_cc - gnuradio.analog.agc_ff - gnuradio.analog.ctcss_squelch_ff - gnuradio.analog.feedforward_agc_cc - gnuradio.blocks.moving_average_cc - gnuradio.blocks.moving_average_ff - gnuradio.blocks.moving_average_ii - gnuradio.blocks.moving_average_ss - gnuradio.blocks.mute_cc - gnuradio.blocks.mute_ff - gnuradio.blocks.mute_ii - gnuradio.blocks.mute_ss - gnuradio.analog.pwr_squelch_cc - gnuradio.analog.pwr_squelch_ff - gnuradio.analog.rail_ff - gnuradio.blocks.sample_and_hold_bb - gnuradio.blocks.sample_and_hold_ff - gnuradio.blocks.sample_and_hold_ii - gnuradio.blocks.sample_and_hold_ss - gnuradio.analog.simple_squelch_cc - gnuradio.blocks.threshold_ff - - -Math Operator Blocks --------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.abs_ff - gnuradio.blocks.abs_ii - gnuradio.blocks.abs_ss - gnuradio.blocks.add_cc - gnuradio.blocks.add_ff - gnuradio.blocks.add_ii - gnuradio.blocks.add_ss - gnuradio.blocks.add_const_bb - gnuradio.blocks.add_const_cc - gnuradio.blocks.add_const_ff - gnuradio.blocks.add_const_ii - gnuradio.blocks.add_const_ss - gnuradio.blocks.add_const_vbb - gnuradio.blocks.add_const_vcc - gnuradio.blocks.add_const_vff - gnuradio.blocks.add_const_vii - gnuradio.blocks.add_const_vss - gnuradio.blocks.argmax_fs - gnuradio.blocks.argmax_is - gnuradio.blocks.argmax_ss - gnuradio.blocks.conjugate_cc - gnuradio.blocks.divide_cc - gnuradio.blocks.divide_ff - gnuradio.blocks.divide_ii - gnuradio.blocks.divide_ss - gnuradio.blocks.integrate_cc - gnuradio.blocks.integrate_ff - gnuradio.blocks.integrate_ii - gnuradio.blocks.integrate_ss - gnuradio.blocks.nlog10_ff - gnuradio.blocks.max_ff - gnuradio.blocks.max_ii - gnuradio.blocks.max_ss - gnuradio.blocks.min_ff - gnuradio.blocks.min_ii - gnuradio.blocks.min_ss - gnuradio.blocks.multiply_cc - gnuradio.blocks.multiply_ff - gnuradio.blocks.multiply_ii - gnuradio.blocks.multiply_ss - gnuradio.blocks.multiply_matrix_ff - gnuradio.blocks.multiply_conjugate_cc - gnuradio.blocks.multiply_const_cc - gnuradio.blocks.multiply_const_ff - gnuradio.blocks.multiply_const_ii - gnuradio.blocks.multiply_const_ss - gnuradio.blocks.multiply_const_vcc - gnuradio.blocks.multiply_const_vff - gnuradio.blocks.multiply_const_vii - gnuradio.blocks.multiply_const_vss - gnuradio.blocks.rms_cf - gnuradio.blocks.rms_ff - gnuradio.blocks.rotator_cc - gnuradio.blocks.sub_cc - gnuradio.blocks.sub_ff - gnuradio.blocks.sub_ii - gnuradio.blocks.sub_ss - gnuradio.blocks.transcendental - - -Measurement Tool Blocks -----------------------_ - -.. autosummary:: - :nosignatures: - - gnuradio.digital.mpsk_snr_est_cc - gnuradio.digital.probe_mpsk_snr_est_c - gnuradio.digital.probe_density_b - gnuradio.blocks.probe_rate - gnuradio.blocks.probe_signal_b - gnuradio.blocks.probe_signal_c - gnuradio.blocks.probe_signal_f - gnuradio.blocks.probe_signal_i - gnuradio.blocks.probe_signal_s - gnuradio.blocks.probe_signal_vb - gnuradio.blocks.probe_signal_vc - gnuradio.blocks.probe_signal_vf - gnuradio.blocks.probe_signal_vi - gnuradio.blocks.probe_signal_vs - - -Message Tool Blocks -------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.message_burst_source - gnuradio.blocks.message_debug - gnuradio.blocks.message_strobe - gnuradio.blocks.message_strobe_random - gnuradio.blocks.pdu_filter - gnuradio.blocks.pdu_remove - gnuradio.blocks.pdu_set - gnuradio.blocks.pdu_to_tagged_stream - gnuradio.blocks.tagged_stream_multiply_length - gnuradio.blocks.tagged_stream_to_pdu - - -Misc Blocks ------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.copy - gnuradio.blocks.delay - gnuradio.blocks.head - gnuradio.blocks.nop - gnuradio.blocks.null_sink - gnuradio.blocks.null_source - gnuradio.blocks.skiphead - gnuradio.blocks.throttle - gnuradio.blocks.vector_source_b - gnuradio.blocks.vector_source_c - gnuradio.blocks.vector_source_f - gnuradio.blocks.vector_source_i - gnuradio.blocks.vector_source_s - - -Modulator Blocks ----------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.am_demod_cf - gnuradio.analog.cpm - gnuradio.analog.cpfsk_bc - gnuradio.analog.frequency_modulator_fc - gnuradio.analog.fm_demod_cf - gnuradio.analog.demod_20k0f3e_cf - gnuradio.analog.demod_200kf3e_cf - gnuradio.analog.fm_deemph - gnuradio.analog.fm_preemph - gnuradio.analog.nbfm_rx - gnuradio.analog.nbfm_tx - gnuradio.analog.phase_modulator_fc - gnuradio.analog.quadrature_demod_cf - gnuradio.analog.wfm_rcv_fmdet - gnuradio.analog.wfm_rcv_pll - gnuradio.analog.wfm_rcv - gnuradio.analog.wfm_tx - - -Networking Tools Blocks ------------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.socket_pdu - gnuradio.blocks.tcp_server_sink - gnuradio.blocks.udp_sink - gnuradio.blocks.udp_source - - -OFDM Blocks ------------ - -.. autosummary:: - :nosignatures: - - gnuradio.digital.ofdm_carrier_allocator_cvc - gnuradio.digital.ofdm_chanest_vcvc - gnuradio.digital.ofdm_cyclic_prefixer - gnuradio.digital.ofdm_equalizer_base - gnuradio.digital.ofdm_equalizer_simpledfe - gnuradio.digital.ofdm_equalizer_static - gnuradio.digital.ofdm_frame_acquisition - gnuradio.digital.ofdm_frame_equalizer_vcvc - gnuradio.digital.ofdm_frame_sink - gnuradio.digital.ofdm_insert_preamble - gnuradio.digital.ofdm_sampler - gnuradio.digital.ofdm_serializer_vcc - gnuradio.digital.ofdm_sync_sc_cfb - - -Packet Operator Blocks ----------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.crc32_async_bb - gnuradio.digital.crc32_bb - gnuradio.digital.correlate_access_code_bb - gnuradio.digital.correlate_access_code_bb_ts - gnuradio.digital.correlate_access_code_ff_ts - gnuradio.digital.correlate_access_code_tag_bb - gnuradio.digital.framer_sink_1 - gnuradio.digital.hdlc_deframer_bp - gnuradio.digital.hdlc_framer_pb - gnuradio.digital.header_payload_demux - gnuradio.digital.packet_header_default - gnuradio.digital.packet_headergenerator_bb - gnuradio.digital.packet_sink - gnuradio.digital.simple_correlator - gnuradio.digital.simple_framer - - -Peak Detector Blocks --------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.burst_tagger - gnuradio.blocks.peak_detector2_fb - gnuradio.blocks.peak_detector_fb - gnuradio.blocks.peak_detector_ib - gnuradio.blocks.peak_detector_sb - gnuradio.blocks.plateau_detector_fb - - -Resampler Blocks ----------------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.mmse_resampler_cc - gnuradio.filter.mmse_resampler_ff - gnuradio.filter.pfb.arb_resampler_ccf - gnuradio.filter.pfb.arb_resampler_fff - gnuradio.filter.pfb.arb_resampler_ccc - gnuradio.filter.pfb_arb_resampler_ccc - gnuradio.filter.pfb_arb_resampler_ccf - gnuradio.filter.pfb_arb_resampler_fff - gnuradio.filter.rational_resampler_fff - gnuradio.filter.rational_resampler_ccf - gnuradio.filter.rational_resampler_ccc - gnuradio.filter.rational_resampler_base_ccc - gnuradio.filter.rational_resampler_base_ccf - gnuradio.filter.rational_resampler_base_fcc - gnuradio.filter.rational_resampler_base_fff - gnuradio.filter.rational_resampler_base_fsf - gnuradio.filter.rational_resampler_base_scc - - -Stream Operator Blocks ----------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.deinterleave - gnuradio.blocks.endian_swap - gnuradio.blocks.keep_m_in_n - gnuradio.blocks.keep_one_in_n - gnuradio.blocks.patterned_interleaver - gnuradio.blocks.regenerate_bb - gnuradio.blocks.repeat - gnuradio.blocks.stream_mux - gnuradio.blocks.stream_to_streams - gnuradio.blocks.stream_to_tagged_stream - gnuradio.blocks.stream_to_vector - gnuradio.blocks.streams_to_stream - gnuradio.blocks.streams_to_vector - gnuradio.blocks.stretch_ff - gnuradio.blocks.tagged_stream_mux - gnuradio.blocks.vector_insert_b - gnuradio.blocks.vector_insert_c - gnuradio.blocks.vector_insert_f - gnuradio.blocks.vector_insert_i - gnuradio.blocks.vector_insert_s - gnuradio.blocks.vector_to_stream - gnuradio.blocks.vector_to_streams - - -Stream Tag Tool Blocks ----------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.stream_to_tagged_stream - gnuradio.blocks.tag_gate - gnuradio.blocks.tagged_stream_align - gnuradio.blocks.tagged_stream_multiply_length - gnuradio.blocks.tagged_stream_mux - - -Symbol Coding Blocks --------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.binary_slicer_fb - gnuradio.digital.chunks_to_symbols_bc - gnuradio.digital.chunks_to_symbols_bf - gnuradio.digital.chunks_to_symbols_ic - gnuradio.digital.chunks_to_symbols_if - gnuradio.digital.chunks_to_symbols_sc - gnuradio.digital.chunks_to_symbols_sf - gnuradio.digital.constellation_decoder_cb - gnuradio.digital.constellation_soft_decoder_cf - gnuradio.digital.diff_decoder_bb - gnuradio.digital.diff_encoder_bb - gnuradio.digital.diff_phasor_cc - gnuradio.digital.map_bb - - -Synchronizer Blocks --------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.digital.clock_recovery_mm_cc - gnuradio.digital.clock_recovery_mm_ff - gnuradio.digital.correlate_and_sync_cc - gnuradio.digital.corr_est_cc - gnuradio.digital.costas_loop_cc - gnuradio.digital.fll_band_edge_cc - gnuradio.digital.msk_timing_recovery_cc - gnuradio.analog.pll_carriertracking_cc - gnuradio.analog.pll_freqdet_cf - gnuradio.analog.pll_refout_cc - gnuradio.digital.pn_correlator_cc - gnuradio.digital.pfb_clock_sync_ccf - gnuradio.digital.pfb_clock_sync_fff - - -Trellis Coding Blocks ---------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.trellis.constellation_metrics_cf - gnuradio.trellis.encoder_bb - gnuradio.trellis.encoder_bi - gnuradio.trellis.encoder_bs - gnuradio.trellis.encoder_ii - gnuradio.trellis.encoder_si - gnuradio.trellis.encoder_ss - gnuradio.trellis.metrics_c - gnuradio.trellis.metrics_f - gnuradio.trellis.metrics_i - gnuradio.trellis.metrics_s - gnuradio.trellis.pccc_decoder_b - gnuradio.trellis.pccc_decoder_combined_cb - gnuradio.trellis.pccc_decoder_combined_ci - gnuradio.trellis.pccc_decoder_combined_cs - gnuradio.trellis.pccc_decoder_combined_fb - gnuradio.trellis.pccc_decoder_combined_fi - gnuradio.trellis.pccc_decoder_combined_fs - gnuradio.trellis.pccc_decoder_i - gnuradio.trellis.pccc_decoder_s - gnuradio.trellis.pccc_encoder_bb - gnuradio.trellis.pccc_encoder_bi - gnuradio.trellis.pccc_encoder_bs - gnuradio.trellis.pccc_encoder_ii - gnuradio.trellis.pccc_encoder_si - gnuradio.trellis.pccc_encoder_ss - gnuradio.trellis.permutation - gnuradio.trellis.sccc_decoder_b - gnuradio.trellis.sccc_decoder_combined_cb - gnuradio.trellis.sccc_decoder_combined_ci - gnuradio.trellis.sccc_decoder_combined_cs - gnuradio.trellis.sccc_decoder_combined_fb - gnuradio.trellis.sccc_decoder_combined_fi - gnuradio.trellis.sccc_decoder_combined_fs - gnuradio.trellis.sccc_decoder_i - gnuradio.trellis.sccc_decoder_s - gnuradio.trellis.sccc_encoder_bb - gnuradio.trellis.sccc_encoder_bi - gnuradio.trellis.sccc_encoder_bs - gnuradio.trellis.sccc_encoder_ii - gnuradio.trellis.sccc_encoder_si - gnuradio.trellis.sccc_encoder_ss - gnuradio.trellis.siso_combined_f - gnuradio.trellis.siso_f - gnuradio.trellis.viterbi_b - gnuradio.trellis.viterbi_combined_cb - gnuradio.trellis.viterbi_combined_ci - gnuradio.trellis.viterbi_combined_cs - gnuradio.trellis.viterbi_combined_fb - gnuradio.trellis.viterbi_combined_fi - gnuradio.trellis.viterbi_combined_fs - gnuradio.trellis.viterbi_combined_ib - gnuradio.trellis.viterbi_combined_ii - gnuradio.trellis.viterbi_combined_is - gnuradio.trellis.viterbi_combined_sb - gnuradio.trellis.viterbi_combined_si - gnuradio.trellis.viterbi_combined_ss - gnuradio.trellis.viterbi_i - gnuradio.trellis.viterbi_s - - - -Type Converter Blocks ---------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.blocks.char_to_float - gnuradio.blocks.char_to_short - gnuradio.blocks.complex_to_arg - gnuradio.blocks.complex_to_float - gnuradio.blocks.complex_to_imag - gnuradio.blocks.complex_to_interleaved_short - gnuradio.blocks.complex_to_mag - gnuradio.blocks.complex_to_mag_squared - gnuradio.blocks.complex_to_real - gnuradio.blocks.float_to_char - gnuradio.blocks.float_to_complex - gnuradio.blocks.float_to_int - gnuradio.blocks.float_to_short - gnuradio.blocks.float_to_uchar - gnuradio.blocks.int_to_float - gnuradio.blocks.interleaved_char_to_complex - gnuradio.blocks.interleaved_short_to_complex - gnuradio.blocks.short_to_char - gnuradio.blocks.short_to_float - gnuradio.blocks.uchar_to_float - - - -UHD Blocks ----------- - -.. autosummary:: - :nosignatures: - - gnuradio.uhd.amsg_source - gnuradio.uhd.usrp_sink - gnuradio.uhd.usrp_source - - - -Waveform Generator Blocks -------------------------- - - gnuradio.analog.fastnoise_source_c - gnuradio.analog.fastnoise_source_f - gnuradio.analog.fastnoise_source_i - gnuradio.analog.fastnoise_source_s - gnuradio.analog.noise_source_c - gnuradio.analog.noise_source_f - gnuradio.analog.noise_source_i - gnuradio.analog.noise_source_s - gnuradio.digital.glfsr_source_b - gnuradio.digital.glfsr_source_f - gnuradio.analog.sig_source_c - gnuradio.analog.sig_source_f - gnuradio.analog.sig_source_i - gnuradio.analog.sig_source_s - gnuradio.analog.sig_source_b - - -ZeroMQ Interface Blocks ------------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.zeromq.pub_msg_sink - gnuradio.zeromq.pub_sink - gnuradio.zeromq.pull_msg_source - gnuradio.zeromq.pull_source - gnuradio.zeromq.push_msg_sink - gnuradio.zeromq.push_sink - gnuradio.zeromq.rep_msg_sink - gnuradio.zeromq.rep_sink - gnuradio.zeromq.req_msg_source - gnuradio.zeromq.req_source - gnuradio.zeromq.sub_msg_source - gnuradio.zeromq.sub_source - - -Helper Classes: Analog ----------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.analog.cpm - gnuradio.analog.squelch_base_cc - gnuradio.analog.squelch_base_ff - gnuradio.analog.cpm - gnuradio.analog.squelch_base_cc - gnuradio.analog.squelch_base_ff - gnuradio.analog.am_demod_cf - gnuradio.analog.demod_10k0a3e_cf - gnuradio.analog.fm_demod_cf - gnuradio.analog.demod_20k0f3e_cf - gnuradio.analog.demod_200kf3e_cf - gnuradio.analog.fm_deemph - gnuradio.analog.fm_preemph - gnuradio.analog.nbfm_rx - gnuradio.analog.nbfm_tx - gnuradio.analog.ctcss_gen_f - gnuradio.analog.standard_squelch - gnuradio.analog.wfm_rcv_fmdet - gnuradio.analog.wfm_rcv_pll - gnuradio.analog.wfm_rcv - gnuradio.analog.wfm_tx - - -Helper Classes: Digital ------------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.digital.constellation - gnuradio.digital.lfsr - gnuradio.digital.mpsk_snr_est - gnuradio.digital.simple_framer - gnuradio.digital.crc32 - gnuradio.digital.update_crc32 - gnuradio.digital.bpsk_mod - gnuradio.digital.bpsk_demod - gnuradio.digital.dbpsk_mod - gnuradio.digital.dbpsk_demod - gnuradio.digital.constellation_map_generator - gnuradio.digital.cpm_mod - gnuradio.digital.gen_and_append_crc32 - gnuradio.digital.check_crc32 - gnuradio.digital.generic_mod - gnuradio.digital.generic_demod - gnuradio.digital.gfsk_mod - gnuradio.digital.gfsk_demod - gnuradio.digital.gmsk_mod - gnuradio.digital.gmsk_demod - gnuradio.digital.type_1_mods - gnuradio.digital.add_type_1_mod - gnuradio.digital.type_1_demods - gnuradio.digital.add_type_1_demod - gnuradio.digital.type_1_constellations - gnuradio.digital.add_type_1_constellation - gnuradio.digital.extract_kwargs_from_options - gnuradio.digital.extract_kwargs_from_options_for_class - gnuradio.digital.ofdm_packet_utils.conv_packed_binary_string_to_1_0_string - gnuradio.digital.ofdm_packet_utils.conv_1_0_string_to_packed_binary_string - gnuradio.digital.ofdm_packet_utils.is_1_0_string - gnuradio.digital.ofdm_packet_utils.string_to_hex_list - gnuradio.digital.ofdm_packet_utils.whiten - gnuradio.digital.ofdm_packet_utils.dewhiten - gnuradio.digital.ofdm_packet_utils.make_header - gnuradio.digital.ofdm_packet_utils.make_packet - gnuradio.digital.ofdm_packet_utils.unmake_packet - gnuradio.digital.ofdm_mod - gnuradio.digital.ofdm_demod - gnuradio.digital.ofdm_receiver - gnuradio.digital.ofdm_sync_fixed - gnuradio.digital.ofdm_sync_ml - gnuradio.digital.ofdm_sync_pnac - gnuradio.digital.ofdm_sync_pn - gnuradio.digital.ofdm_tx - gnuradio.digital.ofdm_rx - gnuradio.digital.packet_utils.conv_packed_binary_string_to_1_0_string - gnuradio.digital.packet_utils.conv_1_0_string_to_packed_binary_string - gnuradio.digital.packet_utils.is_1_0_string - gnuradio.digital.packet_utils.string_to_hex_list - gnuradio.digital.packet_utils.whiten - gnuradio.digital.packet_utils.dewhiten - gnuradio.digital.packet_utils.make_header - gnuradio.digital.packet_utils.make_packet - gnuradio.digital.packet_utils.unmake_packet - gnuradio.digital.psk_2_0x0 - gnuradio.digital.psk_2_0x1 - gnuradio.digital.sd_psk_2_0x0 - gnuradio.digital.sd_psk_2_0x1 - gnuradio.digital.psk_4_0x0_0_1 - gnuradio.digital.psk_4_0x1_0_1 - gnuradio.digital.psk_4_0x2_0_1 - gnuradio.digital.psk_4_0x3_0_1 - gnuradio.digital.psk_4_0x0_1_0 - gnuradio.digital.psk_4_0x1_1_0 - gnuradio.digital.psk_4_0x2_1_0 - gnuradio.digital.psk_4_0x3_1_0 - gnuradio.digital.sd_psk_4_0x0_0_1 - gnuradio.digital.sd_psk_4_0x1_0_1 - gnuradio.digital.sd_psk_4_0x2_0_1 - gnuradio.digital.sd_psk_4_0x3_0_1 - gnuradio.digital.sd_psk_4_0x0_1_0 - gnuradio.digital.sd_psk_4_0x1_1_0 - gnuradio.digital.sd_psk_4_0x2_1_0 - gnuradio.digital.sd_psk_4_0x3_1_0 - gnuradio.digital.psk_constellation - gnuradio.digital.qam_16_0x0_0_1_2_3 - gnuradio.digital.qam_16_0x1_0_1_2_3 - gnuradio.digital.qam_16_0x2_0_1_2_3 - gnuradio.digital.qam_16_0x3_0_1_2_3 - gnuradio.digital.qam_16_0x0_1_0_2_3 - gnuradio.digital.qam_16_0x1_1_0_2_3 - gnuradio.digital.qam_16_0x2_1_0_2_3 - gnuradio.digital.qam_16_0x3_1_0_2_3 - gnuradio.digital.sd_qam_16_0x0_0_1_2_3 - gnuradio.digital.sd_qam_16_0x1_0_1_2_3 - gnuradio.digital.sd_qam_16_0x2_0_1_2_3 - gnuradio.digital.sd_qam_16_0x3_0_1_2_3 - gnuradio.digital.sd_qam_16_0x0_1_0_2_3 - gnuradio.digital.sd_qam_16_0x1_1_0_2_3 - gnuradio.digital.sd_qam_16_0x2_1_0_2_3 - gnuradio.digital.sd_qam_16_0x3_1_0_2_3 - gnuradio.digital.qam32_holeinside_constellation - gnuradio.digital.make_differential_constellation - gnuradio.digital.make_non_differential_constellation - gnuradio.digital.qam_constellation - gnuradio.digital.qpsk_constellation - gnuradio.digital.dqpsk_constellation - gnuradio.digital.soft_dec_table_generator - gnuradio.digital.soft_dec_table - gnuradio.digital.calc_soft_dec_from_table - gnuradio.digital.calc_soft_dec - gnuradio.digital.show_table - -Helper Classes: FEC -------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.fec.cc_decoder - gnuradio.fec.cc_encoder - gnuradio.fec.ccsds_encoder - gnuradio.fec.dummy_decoder - gnuradio.fec.dummy_encoder - gnuradio.fec.ldpc_decoder - gnuradio.fec.ldpc_encoder - gnuradio.fec.repetition_decoder - gnuradio.fec.repetition_encoder - gnuradio.fec.tpc_decoder - gnuradio.fec.tpc_encoder - gnuradio.fec.bercurve_generator - gnuradio.fec.bitreverse - gnuradio.fec.bitflip - gnuradio.fec.read_bitlist - gnuradio.fec.read_big_bitlist - gnuradio.fec.generate_symmetries - gnuradio.fec.capillary_threaded_decoder - gnuradio.fec.capillary_threaded_encoder - gnuradio.fec.extended_async_encoder - gnuradio.fec.extended_decoder - gnuradio.fec.extended_encoder - gnuradio.fec.extended_tagged_decoder - gnuradio.fec.extended_tagged_encoder - gnuradio.fec.fec_test - gnuradio.fec.threaded_decoder - gnuradio.fec.threaded_encoder - -Helper Classes: FFT -------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.fft.window - - -Helper Classes: Filter ----------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.filter.filterbank.analysis_filterbank - gnuradio.filter.filterbank.synthesis_filterbank - gnuradio.filter.firdes - gnuradio.filter.pm_remez - gnuradio.filter.synthesis_filterbank - gnuradio.filter.analysis_filterbank - gnuradio.filter.freq_xlating_fft_filter_ccc - gnuradio.filter.optfir.low_pass - gnuradio.filter.optfir.band_pass - gnuradio.filter.optfir.complex_band_pass - gnuradio.filter.optfir.band_reject - gnuradio.filter.optfir.stopband_atten_to_dev - gnuradio.filter.optfir.passband_ripple_to_dev - gnuradio.filter.optfir.remezord - gnuradio.filter.optfir.lporder - gnuradio.filter.optfir.bporder - gnuradio.filter.pfb.channelizer_ccf - gnuradio.filter.pfb.interpolator_ccf - gnuradio.filter.pfb.decimator_ccf - gnuradio.filter.pfb.arb_resampler_ccf - gnuradio.filter.pfb.arb_resampler_fff - gnuradio.filter.pfb.arb_resampler_ccc - gnuradio.filter.pfb.channelizer_hier_ccf - gnuradio.filter.rational_resampler_fff - gnuradio.filter.rational_resampler_ccf - gnuradio.filter.rational_resampler_ccc - - -Helper Classes: Trellis ------------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.trellis.fsm - gnuradio.trellis.interleaver - - -Helper Classes: UHD -------------------- - -.. autosummary:: - :nosignatures: - - gnuradio.uhd.usrp_block - - -Helper Classes: Vocoder ------------------------ - -.. autosummary:: - :nosignatures: - - gnuradio.vocoder.codec2 - gnuradio.vocoder.cvsd_encode_fb - gnuradio.vocoder.cvsd_decode_bf diff --git a/docs/sphinx/source/pmt.rst b/docs/sphinx/source/pmt.rst deleted file mode 100644 index 2520343cbd..0000000000 --- a/docs/sphinx/source/pmt.rst +++ /dev/null @@ -1,193 +0,0 @@ -gnuradio.pmt -============ - -.. autofunction:: pmt.acons -.. autofunction:: pmt.any_ref -.. autofunction:: pmt.any_set -.. autofunction:: pmt.assoc -.. autofunction:: pmt.assq -.. autofunction:: pmt.assv -.. autofunction:: pmt.blob_data -.. autofunction:: pmt.blob_length -.. autofunction:: pmt.c32vector_elements -.. autofunction:: pmt.c32vector_ref -.. autofunction:: pmt.c32vector_set -.. autofunction:: pmt.c64vector_elements -.. autofunction:: pmt.c64vector_ref -.. autofunction:: pmt.c64vector_set -.. autofunction:: pmt.caar -.. autofunction:: pmt.cadddr -.. autofunction:: pmt.caddr -.. autofunction:: pmt.cadr -.. autofunction:: pmt.car -.. autofunction:: pmt.cdar -.. autofunction:: pmt.cddr -.. autofunction:: pmt.cdr -.. autofunction:: pmt.cons -.. autofunction:: pmt.deserialize -.. autofunction:: pmt.deserialize_str -.. autofunction:: pmt.dict_add -.. autofunction:: pmt.dict_delete -.. autofunction:: pmt.dict_has_key -.. autofunction:: pmt.dict_items -.. autofunction:: pmt.dict_keys -.. autofunction:: pmt.dict_ref -.. autofunction:: pmt.dict_update -.. autofunction:: pmt.dict_values -.. autofunction:: pmt.dump_sizeof -.. autofunction:: pmt.eq -.. autofunction:: pmt.equal -.. autofunction:: pmt.eqv -.. autofunction:: pmt.f32vector_elements -.. autofunction:: pmt.f32vector_ref -.. autofunction:: pmt.f32vector_set -.. autofunction:: pmt.f64vector_elements -.. autofunction:: pmt.f64vector_ref -.. autofunction:: pmt.f64vector_set -.. autofunction:: pmt.from_bool -.. autofunction:: pmt.from_complex -.. autofunction:: pmt.from_double -.. autofunction:: pmt.from_float -.. autofunction:: pmt.from_long -.. autofunction:: pmt.from_uint64 -.. autofunction:: pmt.get_PMT_EOF -.. autofunction:: pmt.get_PMT_F -.. autofunction:: pmt.get_PMT_NIL -.. autofunction:: pmt.get_PMT_T -.. autofunction:: pmt.init_c32vector -.. autofunction:: pmt.init_c64vector -.. autofunction:: pmt.init_f32vector -.. autofunction:: pmt.init_f64vector -.. autofunction:: pmt.init_s16vector -.. autofunction:: pmt.init_s32vector -.. autofunction:: pmt.init_s8vector -.. autofunction:: pmt.init_u16vector -.. autofunction:: pmt.init_u32vector -.. autofunction:: pmt.init_u8vector -.. autofunction:: pmt.intern -.. autofunction:: pmt.is_any -.. autofunction:: pmt.is_blob -.. autofunction:: pmt.is_bool -.. autofunction:: pmt.is_c32vector -.. autofunction:: pmt.is_c64vector -.. autofunction:: pmt.is_complex -.. autofunction:: pmt.is_dict -.. autofunction:: pmt.is_eof_object -.. autofunction:: pmt.is_f32vector -.. autofunction:: pmt.is_f64vector -.. autofunction:: pmt.is_false -.. autofunction:: pmt.is_integer -.. autofunction:: pmt.is_msg_accepter -.. autofunction:: pmt.is_null -.. autofunction:: pmt.is_number -.. autofunction:: pmt.is_pair -.. autofunction:: pmt.is_real -.. autofunction:: pmt.is_s16vector -.. autofunction:: pmt.is_s32vector -.. autofunction:: pmt.is_s64vector -.. autofunction:: pmt.is_s8vector -.. autofunction:: pmt.is_symbol -.. autofunction:: pmt.is_true -.. autofunction:: pmt.is_tuple -.. autofunction:: pmt.is_u16vector -.. autofunction:: pmt.is_u32vector -.. autofunction:: pmt.is_u64vector -.. autofunction:: pmt.is_u8vector -.. autofunction:: pmt.is_uint64 -.. autofunction:: pmt.is_uniform_vector -.. autofunction:: pmt.is_vector -.. autofunction:: pmt.length -.. autofunction:: pmt.list1 -.. autofunction:: pmt.list2 -.. autofunction:: pmt.list3 -.. autofunction:: pmt.list4 -.. autofunction:: pmt.list5 -.. autofunction:: pmt.list6 -.. autofunction:: pmt.list_add -.. autofunction:: pmt.list_has -.. autofunction:: pmt.list_rm -.. autofunction:: pmt.make_any -.. autofunction:: pmt.make_blob -.. autofunction:: pmt.make_c32vector -.. autofunction:: pmt.make_c64vector -.. autofunction:: pmt.make_dict -.. autofunction:: pmt.make_f32vector -.. autofunction:: pmt.make_f64vector -.. autofunction:: pmt.make_msg_accepter -.. autofunction:: pmt.make_rectangular -.. autofunction:: pmt.make_s16vector -.. autofunction:: pmt.make_s32vector -.. autofunction:: pmt.make_s64vector -.. autofunction:: pmt.make_s8vector -.. autofunction:: pmt.make_tuple -.. autofunction:: pmt.make_u16vector -.. autofunction:: pmt.make_u32vector -.. autofunction:: pmt.make_u64vector -.. autofunction:: pmt.make_u8vector -.. autofunction:: pmt.make_vector -.. autofunction:: pmt.map -.. autofunction:: pmt.member -.. autofunction:: pmt.memq -.. autofunction:: pmt.memv -.. autofunction:: pmt.msg_accepter_ref -.. autofunction:: pmt.nth -.. autofunction:: pmt.nthcdr -.. autofunction:: pmt.pmt_vector_cdouble -.. autofunction:: pmt.pmt_vector_cfloat -.. autofunction:: pmt.pmt_vector_double -.. autofunction:: pmt.pmt_vector_float -.. autofunction:: pmt.pmt_vector_int16 -.. autofunction:: pmt.pmt_vector_int32 -.. autofunction:: pmt.pmt_vector_int8 -.. autofunction:: pmt.pmt_vector_uint16 -.. autofunction:: pmt.pmt_vector_uint32 -.. autofunction:: pmt.pmt_vector_uint8 -.. autofunction:: pmt.read -.. autofunction:: pmt.reverse -.. autofunction:: pmt.reverse_x -.. autofunction:: pmt.s16vector_elements -.. autofunction:: pmt.s16vector_ref -.. autofunction:: pmt.s16vector_set -.. autofunction:: pmt.s32vector_elements -.. autofunction:: pmt.s32vector_ref -.. autofunction:: pmt.s32vector_set -.. autofunction:: pmt.s64vector_ref -.. autofunction:: pmt.s64vector_set -.. autofunction:: pmt.s8vector_elements -.. autofunction:: pmt.s8vector_ref -.. autofunction:: pmt.s8vector_set -.. autofunction:: pmt.serialize -.. autofunction:: pmt.serialize_str -.. autofunction:: pmt.set_car -.. autofunction:: pmt.set_cdr -.. autofunction:: pmt.string_to_symbol -.. autofunction:: pmt.subsetp -.. autofunction:: pmt.symbol_to_string -.. autofunction:: pmt.to_bool -.. autofunction:: pmt.to_complex -.. autofunction:: pmt.to_double -.. autofunction:: pmt.to_float -.. autofunction:: pmt.to_long -.. autofunction:: pmt.to_pmt -.. autofunction:: pmt.to_python -.. autofunction:: pmt.to_tuple -.. autofunction:: pmt.to_uint64 -.. autofunction:: pmt.tuple_ref -.. autofunction:: pmt.u16vector_elements -.. autofunction:: pmt.u16vector_ref -.. autofunction:: pmt.u16vector_set -.. autofunction:: pmt.u32vector_elements -.. autofunction:: pmt.u32vector_ref -.. autofunction:: pmt.u32vector_set -.. autofunction:: pmt.u64vector_ref -.. autofunction:: pmt.u64vector_set -.. autofunction:: pmt.u8vector_elements -.. autofunction:: pmt.u8vector_ref -.. autofunction:: pmt.u8vector_set -.. autofunction:: pmt.uniform_vector_elements -.. autofunction:: pmt.uniform_vector_itemsize -.. autofunction:: pmt.vector_fill -.. autofunction:: pmt.vector_ref -.. autofunction:: pmt.vector_set -.. autofunction:: pmt.write -.. autofunction:: pmt.write_string diff --git a/docs/sphinx/source/qtgui_blocks.rst b/docs/sphinx/source/qtgui_blocks.rst deleted file mode 100644 index 4e0910d179..0000000000 --- a/docs/sphinx/source/qtgui_blocks.rst +++ /dev/null @@ -1,20 +0,0 @@ -gnuradio.qtgui -============== - -.. automodule:: gnuradio.qtgui - -.. autoblock:: gnuradio.qtgui.ber_sink_b -.. autoblock:: gnuradio.qtgui.const_sink_c -.. autoblock:: gnuradio.qtgui.freq_sink_c -.. autoblock:: gnuradio.qtgui.freq_sink_f -.. autoblock:: gnuradio.qtgui.histogram_sink_f -.. autoblock:: gnuradio.qtgui.number_sink -.. autoblock:: gnuradio.qtgui.sink_c -.. autoblock:: gnuradio.qtgui.sink_f -.. autoblock:: gnuradio.qtgui.time_raster_sink_b -.. autoblock:: gnuradio.qtgui.time_raster_sink_f -.. autoblock:: gnuradio.qtgui.time_sink_c -.. autoblock:: gnuradio.qtgui.time_sink_f -.. autoblock:: gnuradio.qtgui.vector_sink_f -.. autoblock:: gnuradio.qtgui.waterfall_sink_c -.. autoblock:: gnuradio.qtgui.waterfall_sink_f diff --git a/docs/sphinx/source/runtime.rst b/docs/sphinx/source/runtime.rst deleted file mode 100644 index b94dd90d5e..0000000000 --- a/docs/sphinx/source/runtime.rst +++ /dev/null @@ -1,65 +0,0 @@ -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 diff --git a/docs/sphinx/source/trellis.rst b/docs/sphinx/source/trellis.rst deleted file mode 100644 index 71a37b3e88..0000000000 --- a/docs/sphinx/source/trellis.rst +++ /dev/null @@ -1,5 +0,0 @@ -gnuradio.trellis -================ - -.. autoclass:: gnuradio.trellis.fsm -.. autoclass:: gnuradio.trellis.interleaver diff --git a/docs/sphinx/source/trellis_blocks.rst b/docs/sphinx/source/trellis_blocks.rst deleted file mode 100644 index a872894a50..0000000000 --- a/docs/sphinx/source/trellis_blocks.rst +++ /dev/null @@ -1,64 +0,0 @@ -gnuradio.trellis -================ - -.. automodule:: gnuradio.trellis - -.. autoblock:: gnuradio.trellis.constellation_metrics_cf -.. autoblock:: gnuradio.trellis.encoder_bb -.. autoblock:: gnuradio.trellis.encoder_bi -.. autoblock:: gnuradio.trellis.encoder_bs -.. autoblock:: gnuradio.trellis.encoder_ii -.. autoblock:: gnuradio.trellis.encoder_si -.. autoblock:: gnuradio.trellis.encoder_ss -.. autoblock:: gnuradio.trellis.metrics_c -.. autoblock:: gnuradio.trellis.metrics_f -.. autoblock:: gnuradio.trellis.metrics_i -.. autoblock:: gnuradio.trellis.metrics_s -.. autoblock:: gnuradio.trellis.pccc_decoder_b -.. autoblock:: gnuradio.trellis.pccc_decoder_combined_cb -.. autoblock:: gnuradio.trellis.pccc_decoder_combined_ci -.. autoblock:: gnuradio.trellis.pccc_decoder_combined_cs -.. autoblock:: gnuradio.trellis.pccc_decoder_combined_fb -.. autoblock:: gnuradio.trellis.pccc_decoder_combined_fi -.. autoblock:: gnuradio.trellis.pccc_decoder_combined_fs -.. autoblock:: gnuradio.trellis.pccc_decoder_i -.. autoblock:: gnuradio.trellis.pccc_decoder_s -.. autoblock:: gnuradio.trellis.pccc_encoder_bb -.. autoblock:: gnuradio.trellis.pccc_encoder_bi -.. autoblock:: gnuradio.trellis.pccc_encoder_bs -.. autoblock:: gnuradio.trellis.pccc_encoder_ii -.. autoblock:: gnuradio.trellis.pccc_encoder_si -.. autoblock:: gnuradio.trellis.pccc_encoder_ss -.. autoblock:: gnuradio.trellis.permutation -.. autoblock:: gnuradio.trellis.sccc_decoder_b -.. autoblock:: gnuradio.trellis.sccc_decoder_combined_cb -.. autoblock:: gnuradio.trellis.sccc_decoder_combined_ci -.. autoblock:: gnuradio.trellis.sccc_decoder_combined_cs -.. autoblock:: gnuradio.trellis.sccc_decoder_combined_fb -.. autoblock:: gnuradio.trellis.sccc_decoder_combined_fi -.. autoblock:: gnuradio.trellis.sccc_decoder_combined_fs -.. autoblock:: gnuradio.trellis.sccc_decoder_i -.. autoblock:: gnuradio.trellis.sccc_decoder_s -.. autoblock:: gnuradio.trellis.sccc_encoder_bb -.. autoblock:: gnuradio.trellis.sccc_encoder_bi -.. autoblock:: gnuradio.trellis.sccc_encoder_bs -.. autoblock:: gnuradio.trellis.sccc_encoder_ii -.. autoblock:: gnuradio.trellis.sccc_encoder_si -.. autoblock:: gnuradio.trellis.sccc_encoder_ss -.. autoblock:: gnuradio.trellis.siso_combined_f -.. autoblock:: gnuradio.trellis.siso_f -.. autoblock:: gnuradio.trellis.viterbi_b -.. autoblock:: gnuradio.trellis.viterbi_combined_cb -.. autoblock:: gnuradio.trellis.viterbi_combined_ci -.. autoblock:: gnuradio.trellis.viterbi_combined_cs -.. autoblock:: gnuradio.trellis.viterbi_combined_fb -.. autoblock:: gnuradio.trellis.viterbi_combined_fi -.. autoblock:: gnuradio.trellis.viterbi_combined_fs -.. autoblock:: gnuradio.trellis.viterbi_combined_ib -.. autoblock:: gnuradio.trellis.viterbi_combined_ii -.. autoblock:: gnuradio.trellis.viterbi_combined_is -.. autoblock:: gnuradio.trellis.viterbi_combined_sb -.. autoblock:: gnuradio.trellis.viterbi_combined_si -.. autoblock:: gnuradio.trellis.viterbi_combined_ss -.. autoblock:: gnuradio.trellis.viterbi_i -.. autoblock:: gnuradio.trellis.viterbi_s diff --git a/docs/sphinx/source/uhd.rst b/docs/sphinx/source/uhd.rst deleted file mode 100644 index a9669622c6..0000000000 --- a/docs/sphinx/source/uhd.rst +++ /dev/null @@ -1,4 +0,0 @@ -gnuradio.uhd -============ - -.. autoclass:: gnuradio.uhd.usrp_block diff --git a/docs/sphinx/source/uhd_blocks.rst b/docs/sphinx/source/uhd_blocks.rst deleted file mode 100644 index c9da6ccddb..0000000000 --- a/docs/sphinx/source/uhd_blocks.rst +++ /dev/null @@ -1,8 +0,0 @@ -gnuradio.uhd -============ - -.. automodule:: gnuradio.uhd - -.. autoblock:: gnuradio.uhd.amsg_source -.. autoblock:: gnuradio.uhd.usrp_sink -.. autoblock:: gnuradio.uhd.usrp_source diff --git a/docs/sphinx/source/vocoder.rst b/docs/sphinx/source/vocoder.rst deleted file mode 100644 index 9ab29759f6..0000000000 --- a/docs/sphinx/source/vocoder.rst +++ /dev/null @@ -1,6 +0,0 @@ -gnuradio.vocoder -================ - -.. autoclass:: gnuradio.vocoder.codec2 -.. autoclass:: gnuradio.vocoder.cvsd_encode_fb -.. autoclass:: gnuradio.vocoder.cvsd_decode_bf diff --git a/docs/sphinx/source/vocoder_blocks.rst b/docs/sphinx/source/vocoder_blocks.rst deleted file mode 100644 index ab8e5f650f..0000000000 --- a/docs/sphinx/source/vocoder_blocks.rst +++ /dev/null @@ -1,21 +0,0 @@ -gnuradio.vocoder -================ - -.. automodule:: gnuradio.vocoder - -.. autoblock:: gnuradio.vocoder.alaw_decode_bs -.. autoblock:: gnuradio.vocoder.alaw_encode_sb -.. autoblock:: gnuradio.vocoder.codec2_decode_ps -.. autoblock:: gnuradio.vocoder.codec2_encode_sp -.. autoblock:: gnuradio.vocoder.cvsd_decode_bs -.. autoblock:: gnuradio.vocoder.cvsd_encode_sb -.. autoblock:: gnuradio.vocoder.g721_decode_bs -.. autoblock:: gnuradio.vocoder.g721_encode_sb -.. autoblock:: gnuradio.vocoder.g723_24_decode_bs -.. autoblock:: gnuradio.vocoder.g723_24_encode_sb -.. autoblock:: gnuradio.vocoder.g723_40_decode_bs -.. autoblock:: gnuradio.vocoder.g723_40_encode_sb -.. autoblock:: gnuradio.vocoder.gsm_fr_decode_ps -.. autoblock:: gnuradio.vocoder.gsm_fr_encode_sp -.. autoblock:: gnuradio.vocoder.ulaw_decode_bs -.. autoblock:: gnuradio.vocoder.ulaw_encode_sb diff --git a/docs/sphinx/source/wavelet_blocks.rst b/docs/sphinx/source/wavelet_blocks.rst deleted file mode 100644 index 679bab70c0..0000000000 --- a/docs/sphinx/source/wavelet_blocks.rst +++ /dev/null @@ -1,8 +0,0 @@ -gnuradio.wavelet -================ - -.. automodule:: gnuradio.wavelet - -.. autoblock:: gnuradio.wavelet.squash_ff -.. autoblock:: gnuradio.wavelet.wavelet_ff -.. autoblock:: gnuradio.wavelet.wvps_ff diff --git a/docs/sphinx/source/zeromq_blocks.rst b/docs/sphinx/source/zeromq_blocks.rst deleted file mode 100644 index add946ac1a..0000000000 --- a/docs/sphinx/source/zeromq_blocks.rst +++ /dev/null @@ -1,17 +0,0 @@ -gnuradio.zeromq -=============== - -.. automodule:: gnuradio.zeromq - -.. autoblock:: gnuradio.zeromq.pub_msg_sink -.. autoblock:: gnuradio.zeromq.pub_sink -.. autoblock:: gnuradio.zeromq.pull_msg_source -.. autoblock:: gnuradio.zeromq.pull_source -.. autoblock:: gnuradio.zeromq.push_msg_sink -.. autoblock:: gnuradio.zeromq.push_sink -.. autoblock:: gnuradio.zeromq.rep_msg_sink -.. autoblock:: gnuradio.zeromq.rep_sink -.. autoblock:: gnuradio.zeromq.req_msg_source -.. autoblock:: gnuradio.zeromq.req_source -.. autoblock:: gnuradio.zeromq.sub_msg_source -.. autoblock:: gnuradio.zeromq.sub_source |