summaryrefslogtreecommitdiff
path: root/docs/sphinx/gnuradio_sphinx.py
diff options
context:
space:
mode:
authorTom Rondeau <tom@trondeau.com>2014-07-07 12:18:00 -0400
committerTom Rondeau <tom@trondeau.com>2014-07-07 12:18:00 -0400
commit597b93798a804cde1783d6d2ab53b348d57c44cd (patch)
treeb65e73bb0de634ff5d209b15971ebdabf369a45c /docs/sphinx/gnuradio_sphinx.py
parent1151e5502ccd440ebd89599cf7e4be4fb5ed8334 (diff)
Removing trailing/extra whitespaces before release.
We should be more careful about letting these into the code in the future. In emacs, we can use (add-hook 'before-save-hook 'delete-trailing-whitespace).
Diffstat (limited to 'docs/sphinx/gnuradio_sphinx.py')
-rw-r--r--docs/sphinx/gnuradio_sphinx.py64
1 files changed, 32 insertions, 32 deletions
diff --git a/docs/sphinx/gnuradio_sphinx.py b/docs/sphinx/gnuradio_sphinx.py
index 8b52ed3ba6..22b96c32e7 100644
--- a/docs/sphinx/gnuradio_sphinx.py
+++ b/docs/sphinx/gnuradio_sphinx.py
@@ -30,7 +30,7 @@ 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.
"""
@@ -107,31 +107,31 @@ common_block_members =[
'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',
+ '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',
@@ -159,14 +159,14 @@ class OldBlockDocumenter(FunctionDocumenter):
objtype = 'oldblock'
directivetype = 'function'
# Don't want to use this for generic functions for give low priority.
- priority = -10
-
+ 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))
+ 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)
@@ -191,8 +191,8 @@ class BlockDocumenter(FunctionDocumenter):
objtype = 'block'
directivetype = 'function'
# Don't want to use this for generic functions for give low priority.
- priority = -10
-
+ priority = -10
+
def __init__(self, *args, **kwargs):
super(BlockDocumenter, self).__init__(*args, **kwargs)
# Get class name
@@ -215,7 +215,7 @@ class PyBlockDocumenter(ClassDocumenter):
"""
objtype = 'pyblock'
directivetype = 'class'
-
+
def __init__(self, *args, **kwargs):
super(PyBlockDocumenter, self).__init__(*args, **kwargs)
self.options.members = ALL