nearly blank documantation, links to natlink.readthedocs.io

dictation-toolbox · Apr 26, 2022 · bf943b3 · bf943b3
1 parent d92671c
commit bf943b3
Show file tree

Hide file tree

Showing 80 changed files with 21,940 additions and 19 deletions.
diff --git a/documentation/_build/doctrees/config.doctree b/documentation/_build/doctrees/config.doctree
diff --git a/documentation/_build/doctrees/configure.doctree b/documentation/_build/doctrees/configure.doctree
diff --git a/documentation/_build/doctrees/developers.doctree b/documentation/_build/doctrees/developers.doctree
diff --git a/documentation/_build/doctrees/documentation.doctree b/documentation/_build/doctrees/documentation.doctree
diff --git a/documentation/_build/doctrees/environment.pickle b/documentation/_build/doctrees/environment.pickle
diff --git a/documentation/_build/doctrees/index.doctree b/documentation/_build/doctrees/index.doctree
diff --git a/documentation/_build/doctrees/install.doctree b/documentation/_build/doctrees/install.doctree
diff --git a/documentation/_build/doctrees/loader.doctree b/documentation/_build/doctrees/loader.doctree
diff --git a/documentation/_build/doctrees/modules.doctree b/documentation/_build/doctrees/modules.doctree
diff --git a/documentation/_build/doctrees/natlinkstatus.doctree b/documentation/_build/doctrees/natlinkstatus.doctree
diff --git a/documentation/_build/doctrees/project.doctree b/documentation/_build/doctrees/project.doctree
diff --git a/documentation/_build/html/.buildinfo b/documentation/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6d468b6d747b898509175a32b8c01478
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/documentation/_build/html/_modules/index.html b/documentation/_build/html/_modules/index.html
@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; natlink 1.1.0 documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+            <a href="../index.html" class="icon icon-home"> natlink
+          </a>
+              <div class="version">
+                1.1
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../install.html">Install instructions for Natlink</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../configure.html">Configure Natlink</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../developers.html">Developers instructions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">Modules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../project.html">Project</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">natlink</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
+      <li>Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="natlink/config.html">natlink.config</a></li>
+<li><a href="natlink/loader.html">natlink.loader</a></li>
+<li><a href="natlink/natlinkstatus.html">natlink.natlinkstatus</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 1999, Joel Gould.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/documentation/_build/html/_modules/natlink/config.html b/documentation/_build/html/_modules/natlink/config.html
diff --git a/documentation/_build/html/_modules/natlink/loader.html b/documentation/_build/html/_modules/natlink/loader.html
diff --git a/documentation/_build/html/_modules/natlink/natlinkstatus.html b/documentation/_build/html/_modules/natlink/natlinkstatus.html
diff --git a/documentation/_build/html/_sources/config.rst.txt b/documentation/_build/html/_sources/config.rst.txt
@@ -0,0 +1,13 @@
+
+.. _RefConfig:
+
+config
+======
+The :code:`config` module reads the Natlink config file (`natlink.ini`), as used by other modules, especially the `loader`.
+
+
+
+
+
+.. automodule:: natlink.config
+   :members:
diff --git a/documentation/_build/html/_sources/configure.rst.txt b/documentation/_build/html/_sources/configure.rst.txt
@@ -0,0 +1,5 @@
+Configure Natlink
+=================
+
+Here come the instructions for configuring Natlink to your needs
+
diff --git a/documentation/_build/html/_sources/developers.rst.txt b/documentation/_build/html/_sources/developers.rst.txt
@@ -0,0 +1,10 @@
+Developers instructions
+=======================
+
+Here come the instructions for developers
+
+Setup Visual Studio environment
+-----------------------------------
+
+Further instructions
+--------------------
diff --git a/documentation/_build/html/_sources/documentation.rst.txt b/documentation/_build/html/_sources/documentation.rst.txt
@@ -0,0 +1,45 @@
+
+Documentation
+==============================================================================
+
+The documentation for DT Actions is written in `reStructuredText format`_.
+ReStructuredText is similar to the Markdown format. If you are unfamiliar
+with the format, the `reStructuredText primer`_ might be a good starting
+point.
+
+The `Sphinx documentation engine`_ and `Read the Docs`_ are used to
+generate documentation from the *.rst* files in the *documentation/* folder.
+Docstrings in the source code are included in a semi-automatic way through use
+of the `sphinx.ext.autodoc`_ extension.
+
+To build the documentation locally, install Sphinx and any other documentation
+requirements:
+
+.. code:: shell
+
+   $ cd documentation
+   $ pip install -r requirements.txt
+
+Then run the following command on Windows to build the documentation:
+
+.. code:: shell
+
+   $ make.bat html
+
+Or use the Makefile on other systems:
+
+.. code:: shell
+
+   $ make html
+
+If there were no errors during the build process, open the
+*_build/html/index.html* file in a web browser. Make changes, rebuild the
+documentation and reload the doc page(s) in your browser as you go.
+
+
+.. Links.
+.. _Read the docs: https://readthedocs.org/
+.. _Sphinx documentation engine: https://www.sphinx-doc.org/en/master/
+.. _reStructuredText format: http://docutils.sourceforge.net/rst.html
+.. _restructuredText primer: http://docutils.sourceforge.net/docs/user/rst/quickstart.html
+.. _sphinx.ext.autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
diff --git a/documentation/_build/html/_sources/index.rst.txt b/documentation/_build/html/_sources/index.rst.txt
@@ -0,0 +1,22 @@
+Welcome to Natlink's documentation!
+===================================
+
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   install
+   configure
+   developers
+   modules
+   project
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/documentation/_build/html/_sources/install.rst.txt b/documentation/_build/html/_sources/install.rst.txt
@@ -0,0 +1,5 @@
+Install instructions for Natlink
+===================================
+
+Here come the instructions for install Natlink as an "end user"
+
diff --git a/documentation/_build/html/_sources/loader.rst.txt b/documentation/_build/html/_sources/loader.rst.txt
@@ -0,0 +1,13 @@
+
+.. _RefLoader:
+
+loader
+=================
+The :code:`loader` is what was :code:`natlinkmain`: it loads the various
+modules according to the config file `natlink.ini`.
+
+Moreover, it also handles callbacks from Dragon/Natlink.
+
+
+.. automodule:: natlink.loader
+   :members:
diff --git a/documentation/_build/html/_sources/modules.rst.txt b/documentation/_build/html/_sources/modules.rst.txt
@@ -0,0 +1,12 @@
+Modules
+=======
+
+This section shows per module the documentation
+
+..  toctree::
+    :maxdepth: 2
+
+    loader
+    config
+    natlinkstatus
+
diff --git a/documentation/_build/html/_sources/natlinkstatus.rst.txt b/documentation/_build/html/_sources/natlinkstatus.rst.txt
@@ -0,0 +1,12 @@
+
+.. _RefNatlinkstatus:
+
+natlinkstatus
+=================
+The :code:`natlinkstatus` module gives information about the configured state of Natlink. It gets some dynamic
+information, such as the language of the user profile, from the natlinkmain instance of the loader.
+
+
+
+.. automodule:: natlink.natlinkstatus
+   :members:
diff --git a/documentation/_build/html/_sources/project.rst.txt b/documentation/_build/html/_sources/project.rst.txt
@@ -0,0 +1,9 @@
+
+Project
+==============================================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   documentation