first doxygen->sphinx converted documentation

genn-team · Feb 8, 2024 · b0bedc4 · b0bedc4
1 parent 82a0fa6
commit b0bedc4
Show file tree

Hide file tree

Showing 25 changed files with 349 additions and 84 deletions.
diff --git a/documentation/5/_downloads/1eed1518b8928bc24e721527ef1f9970/mnist_mb_classifier.ipynb b/documentation/5/_downloads/1eed1518b8928bc24e721527ef1f9970/mnist_mb_classifier.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.12"
+      "version": "3.8.0"
     }
   },
   "nbformat": 4,

diff --git a/documentation/5/_downloads/26866b29b5e6aaf47b3ba4c4dbee6718/userproject_jupyter.zip b/documentation/5/_downloads/26866b29b5e6aaf47b3ba4c4dbee6718/userproject_jupyter.zip
diff --git a/documentation/5/_downloads/3e0a0a579abc8e5181823f00a5779b71/userproject_python.zip b/documentation/5/_downloads/3e0a0a579abc8e5181823f00a5779b71/userproject_python.zip
diff --git a/documentation/5/_downloads/64c7fcd62013f68609d54d02d741b663/potjans_microcircuit.ipynb b/documentation/5/_downloads/64c7fcd62013f68609d54d02d741b663/potjans_microcircuit.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.12"
+      "version": "3.8.0"
     }
   },
   "nbformat": 4,

diff --git a/documentation/5/_downloads/f57116a727438d4e47eb66f1b799aa48/superspike_demo.ipynb b/documentation/5/_downloads/f57116a727438d4e47eb66f1b799aa48/superspike_demo.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.12"
+      "version": "3.8.0"
     }
   },
   "nbformat": 4,

diff --git a/documentation/5/_sources/sg_execution_times.rst.txt b/documentation/5/_sources/sg_execution_times.rst.txt
@@ -32,12 +32,12 @@ Computation times
    * - Example
      - Time
      - Mem (MB)
-   * - :ref:`sphx_glr_userproject_mnist_mb_classifier.py` (``..\userproject\mnist_mb_classifier.py``)
+   * - :ref:`sphx_glr_userproject_mnist_mb_classifier.py` (``../userproject/mnist_mb_classifier.py``)
      - 00:00.000
      - 0.0
-   * - :ref:`sphx_glr_userproject_potjans_microcircuit.py` (``..\userproject\potjans_microcircuit.py``)
+   * - :ref:`sphx_glr_userproject_potjans_microcircuit_pygenn.py` (``../userproject/potjans_microcircuit_pygenn.py``)
      - 00:00.000
      - 0.0
-   * - :ref:`sphx_glr_userproject_superspike_demo.py` (``..\userproject\superspike_demo.py``)
+   * - :ref:`sphx_glr_userproject_superspike_demo.py` (``../userproject/superspike_demo.py``)
      - 00:00.000
      - 0.0
diff --git a/documentation/5/_sources/source/pygenn.rst.txt b/documentation/5/_sources/source/pygenn.rst.txt
@@ -73,6 +73,30 @@ pygenn.init\_var\_snippets module
    :undoc-members:
    :show-inheritance:
 
+pygenn.libgenn\_cuda\_backend\_dynamic module
+---------------------------------------------
+
+.. automodule:: pygenn.libgenn_cuda_backend_dynamic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pygenn.libgenn\_dynamic module
+------------------------------
+
+.. automodule:: pygenn.libgenn_dynamic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pygenn.libgenn\_single\_threaded\_cpu\_backend\_dynamic module
+--------------------------------------------------------------
+
+.. automodule:: pygenn.libgenn_single_threaded_cpu_backend_dynamic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 pygenn.model\_preprocessor module
 ---------------------------------
 

diff --git a/documentation/5/_sources/userproject/mnist_mb_classifier.rst.txt b/documentation/5/_sources/userproject/mnist_mb_classifier.rst.txt
@@ -2,7 +2,7 @@
 .. DO NOT EDIT.
 .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
 .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
-.. "userproject\mnist_mb_classifier.py"
+.. "userproject/mnist_mb_classifier.py"
 .. LINE NUMBERS ARE GIVEN BELOW.
 
 .. only:: html

diff --git a/documentation/5/_sources/userproject/potjans_microcircuit.rst.txt b/documentation/5/_sources/userproject/potjans_microcircuit.rst.txt
@@ -2,7 +2,7 @@
 .. DO NOT EDIT.
 .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
 .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
-.. "userproject\potjans_microcircuit.py"
+.. "userproject/potjans_microcircuit.py"
 .. LINE NUMBERS ARE GIVEN BELOW.
 
 .. only:: html

diff --git a/documentation/5/_sources/userproject/superspike_demo.rst.txt b/documentation/5/_sources/userproject/superspike_demo.rst.txt
@@ -2,7 +2,7 @@
 .. DO NOT EDIT.
 .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
 .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
-.. "userproject\superspike_demo.py"
+.. "userproject/superspike_demo.py"
 .. LINE NUMBERS ARE GIVEN BELOW.
 
 .. only:: html

diff --git a/documentation/5/bibliography.html b/documentation/5/bibliography.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Bibliography &#8212; PyGeNN  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />

diff --git a/documentation/5/building_networks.html b/documentation/5/building_networks.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Building networks &#8212; PyGeNN  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />

diff --git a/documentation/5/custom_models.html b/documentation/5/custom_models.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Custom models &#8212; PyGeNN  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />

diff --git a/documentation/5/index.html b/documentation/5/index.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>PyGeNN documentation &#8212; PyGeNN  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />

diff --git a/documentation/5/searchindex.js b/documentation/5/searchindex.js
diff --git a/documentation/5/sg_execution_times.html b/documentation/5/sg_execution_times.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Computation times &#8212; PyGeNN  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
@@ -62,15 +62,15 @@ <h3>Navigation</h3>
 </tr>
 </thead>
 <tbody>
-<tr class="row-even"><td><p><a class="reference internal" href="userproject/mnist_mb_classifier.html#sphx-glr-userproject-mnist-mb-classifier-py"><span class="std std-ref">MNIST classification using an insect-inspired mushroom body model</span></a> (<code class="docutils literal notranslate"><span class="pre">..\userproject\mnist_mb_classifier.py</span></code>)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="userproject/mnist_mb_classifier.html#sphx-glr-userproject-mnist-mb-classifier-py"><span class="std std-ref">MNIST classification using an insect-inspired mushroom body model</span></a> (<code class="docutils literal notranslate"><span class="pre">../userproject/mnist_mb_classifier.py</span></code>)</p></td>
 <td><p>00:00.000</p></td>
 <td><p>0.0</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="userproject/potjans_microcircuit.html#sphx-glr-userproject-potjans-microcircuit-py"><span class="std std-ref">PyGeNN implementation of local cortical microcircuit model</span></a> (<code class="docutils literal notranslate"><span class="pre">..\userproject\potjans_microcircuit.py</span></code>)</p></td>
+<tr class="row-odd"><td><p><span class="xref std std-ref">sphx_glr_userproject_potjans_microcircuit_pygenn.py</span> (<code class="docutils literal notranslate"><span class="pre">../userproject/potjans_microcircuit_pygenn.py</span></code>)</p></td>
 <td><p>00:00.000</p></td>
 <td><p>0.0</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="userproject/superspike_demo.html#sphx-glr-userproject-superspike-demo-py"><span class="std std-ref">PyGeNN implementation of SuperSpike</span></a> (<code class="docutils literal notranslate"><span class="pre">..\userproject\superspike_demo.py</span></code>)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="userproject/superspike_demo.html#sphx-glr-userproject-superspike-demo-py"><span class="std std-ref">PyGeNN implementation of SuperSpike</span></a> (<code class="docutils literal notranslate"><span class="pre">../userproject/superspike_demo.py</span></code>)</p></td>
 <td><p>00:00.000</p></td>
 <td><p>0.0</p></td>
 </tr>

diff --git a/documentation/5/simulating_networks.html b/documentation/5/simulating_networks.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>Simulating networks &#8212; PyGeNN  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />

diff --git a/documentation/5/source/modules.html b/documentation/5/source/modules.html
@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>pygenn &#8212; PyGeNN  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
@@ -94,6 +94,9 @@ <h1>pygenn<a class="headerlink" href="#pygenn" title="Permalink to this heading"
 <li class="toctree-l2"><a class="reference internal" href="pygenn.html#module-pygenn.init_sparse_connectivity_snippets">pygenn.init_sparse_connectivity_snippets module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="pygenn.html#module-pygenn.init_toeplitz_connectivity_snippets">pygenn.init_toeplitz_connectivity_snippets module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="pygenn.html#module-pygenn.init_var_snippets">pygenn.init_var_snippets module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pygenn.html#pygenn-libgenn-cuda-backend-dynamic-module">pygenn.libgenn_cuda_backend_dynamic module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pygenn.html#pygenn-libgenn-dynamic-module">pygenn.libgenn_dynamic module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pygenn.html#pygenn-libgenn-single-threaded-cpu-backend-dynamic-module">pygenn.libgenn_single_threaded_cpu_backend_dynamic module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="pygenn.html#module-pygenn.model_preprocessor">pygenn.model_preprocessor module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="pygenn.html#module-pygenn.neuron_models">pygenn.neuron_models module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="pygenn.html#module-pygenn.postsynaptic_models">pygenn.postsynaptic_models module</a></li>