Clean up nitclk docs

.codecov.yml

@@ -10,7 +10,7 @@ coverage:
         threshhold: 5
     patch:
       default:
-        target: 85%
+        target: 70%
         threshhold: 5
 
 

build/helper/documentation_helper.py

@@ -352,7 +352,10 @@ def _replace_attribute_python_name(a_match):
             aname = attr['name'].lower()
 
     if config['make_link']:
-        return ':py:data:`{0}.Session.{1}`'.format(config['module_name'], aname)
+        if config['module_name'] == 'nitclk':
+            return ':py:attr:`{0}.SessionReference.{1}`'.format(config['module_name'], aname)
+        else:
+            return ':py:data:`{0}.Session.{1}`'.format(config['module_name'], aname)
     else:
         return '{0}'.format(aname)
 
@@ -381,7 +384,10 @@ def _replace_func_python_name(f_match):
         print(config['functions'])
 
     if config['make_link']:
-        return ':py:meth:`{0}.Session.{1}`'.format(config['module_name'], fname)
+        if config['module_name'] == 'nitclk':
+            return ':py:func:`{0}.{1}`'.format(config['module_name'], fname)
+        else:
+            return ':py:meth:`{0}.Session.{1}`'.format(config['module_name'], fname)
     else:
         return '{0}'.format(fname)
 
@@ -491,8 +497,8 @@ def format_type_for_rst_documentation(param, numpy, config):
     return p_type
 
 
-def get_function_rst(function, method_template, numpy, config, indent=0):
-    '''Gets formatted documentation for given function that can be used in rst documentation
+def get_function_rst(function, method_template, numpy, config, indent=0, method_or_function='method'):
+    '''Gets formatted documentation for given function or method that can be used in rst documentation
 
     Args:
         function (dict): function dictionary
@@ -515,7 +521,7 @@ def get_function_rst(function, method_template, numpy, config, indent=0):
     if function['has_repeated_capability'] is True:
         function['documentation']['tip'] = rep_cap_method_desc_rst.format(config['module_name'], function['repeated_capability_type'], function['python_name'], get_params_snippet(function, session_method))
 
-    rst = '.. py:method:: ' + function['python_name'] + suffix + '('
+    rst = '.. py:{0}:: {1}{2}('.format(method_or_function, function['python_name'], suffix)
     rst += get_params_snippet(function, session_method) + ')'
     indent += 4
     rst += get_documentation_for_node_rst(function, config, indent)

build/helper/metadata_add_all.py

@@ -335,8 +335,12 @@ def _setup_init_function(functions, config):
 
         functions['_init_function'] = init_function
     except KeyError:
-        print("Couldn't find {} init function".format(config['init_function']))
-        pass
+        if 'init_function' not in config or config['init_function'] is None:
+            # We don't have an init function or it is set to None (same thing) so we can't
+            # do anything here
+            pass
+        else:
+            print("Couldn't find {} init function".format(config['init_function']))
 
 
 def add_all_function_metadata(functions, config):

build/templates/class.rst.mako

@@ -62,11 +62,10 @@ ${helper.get_rst_header_snippet(item, '-')}
 
 % endfor
 
+% if len(attributes) > 0:
 ${helper.get_rst_header_snippet('Properties', '=')}
 
 % for attr in helper.sorted_attrs(attributes):
-<% # ${helper.get_rst_header_snippet(attributes[attr]["python_name"], '~')}
-%>\
 ${helper.get_rst_header_snippet(attributes[attr]['python_name'], '-')}
 
     .. py:attribute:: ${attributes[attr]["python_name"]}
@@ -101,6 +100,7 @@ desc = helper.get_documentation_for_node_rst(a, config, indent=0)
                 - C Attribute: **${c_function_prefix.upper()}ATTR_${attributes[attr]["name"].upper()}**
 
 % endfor
+% endif
 
 .. contents:: Session
 

build/templates/conf.py.mako

@@ -103,7 +103,9 @@ html_theme = 'sphinx_rtd_theme'
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'navigation_depth': -1,
+}
 
 # 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,
@@ -186,9 +188,6 @@ texinfo_documents = [
      'Miscellaneous'),
 ]
 
-
-
-
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
 

docs/conf.py

@@ -182,9 +182,6 @@ def setup(app):
      'Miscellaneous'),
 ]
 
-
-
-
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
 

docs/nise/class.rst

@@ -712,9 +712,6 @@ wait_for_debounce
             :type maximum_time_ms: float in seconds or datetime.timedelta
 
 
-Properties
-==========
-
 
 .. contents:: Session