Enable tclk documentation (#1029)

* Add initial metadata * Create nitclk.mak * Remove numpy restriction Bug fixed * Upgrade pip * Remove specific version of flake8 '\' in comments now need to be escaped * Add basepython section * Try using pypy3.5 * Go back to pypy3 and remove basepython block * Don't need to run build_test for all builds - only 3.6 * Remove warning from coverage * Undo previous change * Try disabling faulthandler * Remove --no-faulthandler * pypy needs an older version of pytest See pytest-dev/pytest#5807 * Use platform_python_implementation since implementation_name is not defined on Python2 * Try to get back to the initial coverage * Do the same thing for build_test * Remove redundant pip * Add codecov file to try to control limits for passing * Enable nitclk build * There are some files we will need to skip for now * Add generated nitclk files * Update generated files * Can't skip README.rst * Update templates * Add new cases for buffers with a converter * Need to handle ' []' to normalize everything * Get the session handle name from config instead of hardcoding 'vi' * Temp commit * Fix syntax error * Test new cases * Force change * Update generated files * Update generated files * Add different target for pr (project) and commit (patch) * threshold should be number * Renumber scaler cases to be in order used in the code * Update generated files * Renumber buffer cases to match order used in code * Move and rename test to match case (C020) * Update generated files * Add nitclk specific session template * No longer need to skip generating session.py * Add new session.py * Add placeholder nitclk example * Enable example documentation build * Add generated examples.rst * Add TClk to static files * Add tclk to index * Add tclk top level file * Update generated files
ni · Sep 19, 2019 · 0528006 · 0528006
1 parent 01104d4
commit 0528006
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 4 deletions.
diff --git a/.codecov.yml b/.codecov.yml
@@ -13,3 +13,4 @@ coverage:
         target: 35%
         threshhold: 5
 
+
diff --git a/README.rst b/README.rst
@@ -444,8 +444,9 @@ Driver specific installation instructions can be found on Read The Docs:
 * `nifgen <http://nimi-python.readthedocs.io/en/master/nifgen.html#installation>`_
 * `niscope <http://nimi-python.readthedocs.io/en/master/niscope.html#installation>`_
 * `niswitch <http://nimi-python.readthedocs.io/en/master/niswitch.html#installation>`_
-* `nimodinst <http://nimi-python.readthedocs.io/en/master/nimodinst.html#installation>`_
 * `nise <http://nimi-python.readthedocs.io/en/master/nise.html#installation>`_
+* `nimodinst <http://nimi-python.readthedocs.io/en/master/nimodinst.html#installation>`_
+* `nitclk <http://nimi-python.readthedocs.io/en/master/nitclk.html#installation>`_
 
 
 Contributing

diff --git a/docs/_static/installation.inc b/docs/_static/installation.inc
@@ -10,7 +10,8 @@ Driver specific installation instructions can be found on Read The Docs:
 * `nifgen <http://nimi-python.readthedocs.io/en/master/nifgen.html#installation>`_
 * `niscope <http://nimi-python.readthedocs.io/en/master/niscope.html#installation>`_
 * `niswitch <http://nimi-python.readthedocs.io/en/master/niswitch.html#installation>`_
-* `nimodinst <http://nimi-python.readthedocs.io/en/master/nimodinst.html#installation>`_
 * `nise <http://nimi-python.readthedocs.io/en/master/nise.html#installation>`_
+* `nimodinst <http://nimi-python.readthedocs.io/en/master/nimodinst.html#installation>`_
+* `nitclk <http://nimi-python.readthedocs.io/en/master/nitclk.html#installation>`_
 
 
diff --git a/docs/_static/intro.inc b/docs/_static/intro.inc
@@ -10,8 +10,9 @@ Intro
 * NI-FGEN (Python module: nifgen)
 * NI-SCOPE (Python module: niscope)
 * NI-SWITCH (Python module: niswitch)
-* NI-ModInst (Python module: nimodinst)
 * NI Switch Executive (Python module: nise)
+* NI-ModInst (Python module: nimodinst)
+* NI-TClk (Python module: nitclk)
 
 **nimi-python** supports all the Operating Systems supported by the underlying driver.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -33,8 +33,9 @@ Refer to your driver documentation for device-specific information and detailed
    nifgen
    niscope
    niswitch
-   nimodinst
    nise
+   nimodinst
+   nitclk
 
 Indices and tables
 ==================

diff --git a/docs/nitclk.rst b/docs/nitclk.rst
@@ -0,0 +1,10 @@
+nitclk module
+=============================================================
+
+.. include:: nitclk/installation.inc
+
+.. include:: _static/nitclk_usage.inc
+
+.. include:: nitclk/toc.inc
+
+