diff --git a/doc/htmldoc/_ext/extractor_userdocs.py b/doc/htmldoc/_ext/extractor_userdocs.py
index 147888a7f2..39146b1059 100644
--- a/doc/htmldoc/_ext/extractor_userdocs.py
+++ b/doc/htmldoc/_ext/extractor_userdocs.py
@@ -31,8 +31,9 @@
import logging
from collections import Counter
+
logging.basicConfig(level=logging.WARNING)
-log = logging.getLogger()
+log = logging.getLogger(__name__)
def relative_glob(*pattern, basedir=os.curdir, **kwargs):
diff --git a/doc/htmldoc/_ext/list_examples.py b/doc/htmldoc/_ext/list_examples.py
new file mode 100644
index 0000000000..95dcec0840
--- /dev/null
+++ b/doc/htmldoc/_ext/list_examples.py
@@ -0,0 +1,147 @@
+# -*- coding: utf-8 -*-
+#
+# list_examples.py
+#
+# This file is part of NEST.
+#
+# Copyright (C) 2004 The NEST Initiative
+#
+# NEST is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# NEST is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with NEST. If not, see .
+
+from docutils import nodes
+from docutils.parsers.rst import Directive, Parser
+
+from sphinx.application import Sphinx
+from sphinx.util.docutils import SphinxDirective
+import os
+import glob
+
+import logging
+
+logging.basicConfig(level=logging.WARNING)
+log = logging.getLogger(__name__)
+
+
+class listnode(nodes.General, nodes.Element):
+ pass
+
+
+def ProcessExamples(app, doctree, docname):
+ # Create the bullet list of examples, sorted by title
+ # given by the model name in the directive argument
+
+ env = app.builder.env
+ examples_titles_map = {}
+
+ try:
+ models_to_examples_map = ModelMatchExamples()
+
+ for node in doctree.findall(listnode):
+ for requested_list in env.list_examples_directive_requests:
+ # compare current location with attribute location to get
+ # correct model name
+ if requested_list["name"] == docname:
+ if requested_list["model_name"] not in models_to_examples_map:
+ log.info("No examples found for Model: " + requested_list["model_name"])
+ bullet_list = nodes.Text("None")
+ break
+
+ list_of_examples = models_to_examples_map[requested_list["model_name"]]
+ for value in list_of_examples:
+ mydocname = os.path.splitext(value)[0]
+ examples_titles_map[mydocname] = str(env.titles[mydocname].children[0])
+ sorted_examples = dict(sorted(examples_titles_map.items(), key=lambda kv: kv[1]))
+ bullet_list = nodes.bullet_list()
+
+ for filename, title in sorted_examples.items():
+ # Create a reference node that links to the example
+ # equivalent to HTML
+ list_item = nodes.list_item()
+ newnode = nodes.reference("", "")
+ newnode["internal"] = True
+ newnode["refdocname"] = filename
+ newnode["refuri"] = app.builder.get_relative_uri(docname, filename)
+ newnode.append(nodes.Text(title))
+ para = nodes.paragraph()
+ para += newnode
+ list_item.append(para)
+ bullet_list += list_item
+
+ node.replace_self(bullet_list)
+
+ except Exception as e:
+ log.warning(repr(e))
+ log.warning("exception of class: %s", e.__class__)
+ raise
+
+
+def ModelMatchExamples():
+ # Get list of models and search the examples directory for matches
+
+ filepath_models = "../../models/"
+ filepath_examples = "auto_examples/"
+
+ model_files = []
+ for filename in os.listdir(filepath_models):
+ if filename.endswith(".h"):
+ model_files.append(os.path.splitext(filename)[0])
+
+ matches = {}
+ files = glob.glob(filepath_examples + "**/*.rst", recursive=True)
+ for filename in files:
+ if "auto_examples/index" in filename:
+ continue
+ with open(filename, "r", errors="ignore") as file:
+ content = file.read()
+ for model_file in model_files:
+ if model_file in content:
+ matches.setdefault(model_file, []).append(filename)
+
+ return matches
+
+
+class ListExamplesDirective(SphinxDirective):
+ # Provide a list of the examples that contain the given model name.
+ # The model name is the required argument in the directive
+ # (.. listexamples:: model_name). No options, nor content is expected.
+
+ has_content = False
+ required_arguments = 1
+ option_spec = {}
+
+ def run(self):
+ model_arg = self.arguments[0]
+
+ if not hasattr(self.env, "list_examples_directive_requests"):
+ self.env.list_examples_directive_requests = []
+
+ # See TODO tutorial in Sphinx for more info.
+ # Using environment attribute list_examples_directive_requests to store argument and
+ # its location (docname)
+ self.env.list_examples_directive_requests.append({"model_name": model_arg, "name": self.env.docname})
+
+ return [listnode("")]
+
+
+def setup(app):
+ # Note that the directive names need to be all lower case
+ app.add_directive("listexamples", ListExamplesDirective)
+ app.add_node(listnode)
+ app.connect("doctree-resolved", ProcessExamples)
+
+ return {
+ "version": "0.1",
+ "parallel_read_safe": True,
+ "parallel_write_safe": True,
+ }
diff --git a/doc/htmldoc/conf.py b/doc/htmldoc/conf.py
index 18fa827ab0..244713c699 100644
--- a/doc/htmldoc/conf.py
+++ b/doc/htmldoc/conf.py
@@ -48,6 +48,7 @@
master_doc = "index"
extensions = [
"sphinx_gallery.gen_gallery",
+ "list_examples",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.autosummary",
diff --git a/models/ac_generator.h b/models/ac_generator.h
index a96c0b37ba..947301a622 100644
--- a/models/ac_generator.h
+++ b/models/ac_generator.h
@@ -105,6 +105,11 @@ See also
dc_generator, noise_generator, step_current_generator, StimulationDevice,
Device
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: ac_generator
+
EndUserDocs */
namespace nest
diff --git a/models/aeif_cond_alpha.h b/models/aeif_cond_alpha.h
index 9c9b1f8f44..28e66cfc71 100644
--- a/models/aeif_cond_alpha.h
+++ b/models/aeif_cond_alpha.h
@@ -185,6 +185,11 @@ See also
iaf_cond_alpha, aeif_cond_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_cond_alpha
+
EndUserDocs */
class aeif_cond_alpha : public ArchivingNode
diff --git a/models/aeif_cond_alpha_multisynapse.h b/models/aeif_cond_alpha_multisynapse.h
index a1840e028b..6d8420e4d2 100644
--- a/models/aeif_cond_alpha_multisynapse.h
+++ b/models/aeif_cond_alpha_multisynapse.h
@@ -160,6 +160,11 @@ See also
aeif_cond_alpha_multisynapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_cond_alpha_multisynapse
+
EndUserDocs */
namespace nest
diff --git a/models/aeif_cond_beta_multisynapse.h b/models/aeif_cond_beta_multisynapse.h
index 97a6df953d..498dbaf038 100644
--- a/models/aeif_cond_beta_multisynapse.h
+++ b/models/aeif_cond_beta_multisynapse.h
@@ -177,6 +177,11 @@ See also
aeif_cond_alpha_multisynapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_cond_beta_multisynapse
+
EndUserDocs */
class aeif_cond_beta_multisynapse : public ArchivingNode
diff --git a/models/aeif_cond_exp.h b/models/aeif_cond_exp.h
index f9941ecd7b..2a2b5ac1cc 100644
--- a/models/aeif_cond_exp.h
+++ b/models/aeif_cond_exp.h
@@ -186,6 +186,11 @@ See also
iaf_cond_exp, aeif_cond_alpha
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_cond_exp
+
EndUserDocs */
class aeif_cond_exp : public ArchivingNode
diff --git a/models/aeif_psc_alpha.h b/models/aeif_psc_alpha.h
index 66fd93aa3f..7ddbad8c83 100644
--- a/models/aeif_psc_alpha.h
+++ b/models/aeif_psc_alpha.h
@@ -176,6 +176,11 @@ See also
iaf_psc_alpha, aeif_cond_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_psc_alpha
+
EndUserDocs */
class aeif_psc_alpha : public ArchivingNode
diff --git a/models/aeif_psc_delta.h b/models/aeif_psc_delta.h
index e7e73fdbed..b37ca363b6 100644
--- a/models/aeif_psc_delta.h
+++ b/models/aeif_psc_delta.h
@@ -165,6 +165,11 @@ See also
iaf_psc_delta, aeif_cond_exp, aeif_psc_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_psc_delta
+
EndUserDocs */
class aeif_psc_delta : public ArchivingNode
diff --git a/models/aeif_psc_delta_clopath.h b/models/aeif_psc_delta_clopath.h
index e86194c0a5..a7593a5844 100644
--- a/models/aeif_psc_delta_clopath.h
+++ b/models/aeif_psc_delta_clopath.h
@@ -196,6 +196,11 @@ See also
aeif_psc_delta, clopath_synapse, hh_psc_alpha_clopath
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_psc_delta_clopath
+
EndUserDocs */
class aeif_psc_delta_clopath : public ClopathArchivingNode
diff --git a/models/aeif_psc_exp.h b/models/aeif_psc_exp.h
index ceb61c7b0a..7569f8126c 100644
--- a/models/aeif_psc_exp.h
+++ b/models/aeif_psc_exp.h
@@ -173,6 +173,11 @@ See also
iaf_psc_exp, aeif_cond_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: aeif_psc_exp
+
EndUserDocs */
class aeif_psc_exp : public ArchivingNode
diff --git a/models/bernoulli_synapse.h b/models/bernoulli_synapse.h
index 4b2fd9448c..49fb352741 100644
--- a/models/bernoulli_synapse.h
+++ b/models/bernoulli_synapse.h
@@ -86,6 +86,11 @@ See also
static_synapse, static_synapse_hom_w
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: bernoulli_synapse
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/clopath_synapse.h b/models/clopath_synapse.h
index 31632578ff..b81bc0ee8e 100644
--- a/models/clopath_synapse.h
+++ b/models/clopath_synapse.h
@@ -105,6 +105,11 @@ See also
stdp_synapse, aeif_psc_delta_clopath, hh_psc_alpha_clopath
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_alpha
+
EndUserDocs */
// connections are templates of target identifier type (used for pointer /
diff --git a/models/cm_default.h b/models/cm_default.h
index ea39d81eb8..07f913f787 100644
--- a/models/cm_default.h
+++ b/models/cm_default.h
@@ -223,6 +223,11 @@ See also
NEURON simulator ;-D
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: cm_default
+
EndUserDocs*/
class cm_default : public ArchivingNode
diff --git a/models/cont_delay_synapse.h b/models/cont_delay_synapse.h
index 9b90de1c24..6580c28ce9 100644
--- a/models/cont_delay_synapse.h
+++ b/models/cont_delay_synapse.h
@@ -71,6 +71,11 @@ See also
static_synapse, iaf_psc_alpha_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: cont_delay_synapse
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/correlation_detector.h b/models/correlation_detector.h
index fbbecd040f..a74a21968a 100644
--- a/models/correlation_detector.h
+++ b/models/correlation_detector.h
@@ -140,6 +140,11 @@ See also
spike_recorder
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: correlation_detector
+
EndUserDocs */
/**
diff --git a/models/correlomatrix_detector.h b/models/correlomatrix_detector.h
index 16fd5918f7..cf8fe524c1 100644
--- a/models/correlomatrix_detector.h
+++ b/models/correlomatrix_detector.h
@@ -130,6 +130,11 @@ See also
correlation_detector, spike_recorder
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: correlomatrix_detector
+
EndUserDocs */
/**
diff --git a/models/correlospinmatrix_detector.h b/models/correlospinmatrix_detector.h
index 74c9bbe033..f341089e16 100644
--- a/models/correlospinmatrix_detector.h
+++ b/models/correlospinmatrix_detector.h
@@ -120,6 +120,11 @@ See also
correlation_detector, correlomatrix_detector, spike_recorder
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: correlospinmatrix_detector
+
EndUserDocs */
/**
diff --git a/models/dc_generator.h b/models/dc_generator.h
index 8563134a0d..82edd6efee 100644
--- a/models/dc_generator.h
+++ b/models/dc_generator.h
@@ -82,6 +82,11 @@ See also
ac_generator, noise_generator, step_current_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: dc_generator
+
EndUserDocs */
class dc_generator : public StimulationDevice
diff --git a/models/diffusion_connection.h b/models/diffusion_connection.h
index 0b0c05c99a..8a550c85d6 100644
--- a/models/diffusion_connection.h
+++ b/models/diffusion_connection.h
@@ -82,6 +82,11 @@ See also
siegert_neuron, rate_connection_instantaneous
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: diffusion_connection
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/erfc_neuron.h b/models/erfc_neuron.h
index ae889d217b..ebedf7638a 100644
--- a/models/erfc_neuron.h
+++ b/models/erfc_neuron.h
@@ -123,6 +123,11 @@ CurrentEvent
See also
++++++++
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: erfc_neuron
+
EndUserDocs */
diff --git a/models/gamma_sup_generator.h b/models/gamma_sup_generator.h
index 08a0701137..ef91ccd3c7 100644
--- a/models/gamma_sup_generator.h
+++ b/models/gamma_sup_generator.h
@@ -88,6 +88,11 @@ See also
ppd_sup_generator, poisson_generator_ps, spike_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gamma_sup_generator
+
EndUserDocs */
class gamma_sup_generator : public StimulationDevice
diff --git a/models/gap_junction.h b/models/gap_junction.h
index 0fdf9b95a6..26a5c8a243 100644
--- a/models/gap_junction.h
+++ b/models/gap_junction.h
@@ -74,6 +74,11 @@ See also
hh_psc_alpha_gap
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gap_junction
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/gauss_rate.h b/models/gauss_rate.h
index c0361c9675..e2c8166680 100644
--- a/models/gauss_rate.h
+++ b/models/gauss_rate.h
@@ -127,6 +127,11 @@ See also
rate_connection_instantaneous, rate_connection_delayed
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gauss_rate
+
EndUserDocs */
class nonlinearities_gauss_rate
diff --git a/models/gif_cond_exp.h b/models/gif_cond_exp.h
index eba3ffb2af..ee5a8b7cc5 100644
--- a/models/gif_cond_exp.h
+++ b/models/gif_cond_exp.h
@@ -213,6 +213,11 @@ See also
pp_psc_delta, gif_cond_exp_multisynapse, gif_psc_exp, gif_psc_exp_multisynapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gif_cond_exp
+
EndUserDocs */
class gif_cond_exp : public ArchivingNode
diff --git a/models/gif_cond_exp_multisynapse.h b/models/gif_cond_exp_multisynapse.h
index 068e8762ec..292d272542 100644
--- a/models/gif_cond_exp_multisynapse.h
+++ b/models/gif_cond_exp_multisynapse.h
@@ -214,6 +214,11 @@ See also
pp_psc_delta, gif_cond_exp, iaf_psc_exp_multisynapse, gif_psc_exp_multisynapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gif_cond_exp_multisynapse
+
EndUserDocs */
class gif_cond_exp_multisynapse : public ArchivingNode
diff --git a/models/gif_pop_psc_exp.h b/models/gif_pop_psc_exp.h
index ba3bc020bf..11d3b44f78 100644
--- a/models/gif_pop_psc_exp.h
+++ b/models/gif_pop_psc_exp.h
@@ -139,6 +139,11 @@ See also
gif_psc_exp, bernoulli_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gif_pop_psc_exp
+
EndUserDocs */
diff --git a/models/gif_psc_exp.h b/models/gif_psc_exp.h
index b6d553cc08..c9082ba317 100644
--- a/models/gif_psc_exp.h
+++ b/models/gif_psc_exp.h
@@ -197,6 +197,11 @@ See also
pp_psc_delta, gif_psc_exp_multisynapse, gif_cond_exp, gif_cond_exp_multisynapse, gif_pop_psc_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gif_psc_exp
+
EndUserDocs */
class gif_psc_exp : public ArchivingNode
diff --git a/models/gif_psc_exp_multisynapse.h b/models/gif_psc_exp_multisynapse.h
index 4c832ec11a..df572d3aac 100644
--- a/models/gif_psc_exp_multisynapse.h
+++ b/models/gif_psc_exp_multisynapse.h
@@ -203,6 +203,11 @@ See also
pp_psc_delta, gif_psc_exp, gif_cond_exp, gif_cond_exp_multisynapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: gif_psc_exp_multisynapse
+
EndUserDocs */
class gif_psc_exp_multisynapse : public ArchivingNode
diff --git a/models/ginzburg_neuron.h b/models/ginzburg_neuron.h
index 4e5745d222..7555b9b3ed 100644
--- a/models/ginzburg_neuron.h
+++ b/models/ginzburg_neuron.h
@@ -128,6 +128,11 @@ See also
++++++++
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: ginzburg_neuron
+
EndUserDocs */
class gainfunction_ginzburg
diff --git a/models/glif_cond.h b/models/glif_cond.h
index 333a82fe69..116033c72f 100644
--- a/models/glif_cond.h
+++ b/models/glif_cond.h
@@ -195,6 +195,11 @@ See also
gif_psc_exp_multisynapse, gif_cond_exp, gif_cond_exp_multisynapse, gif_pop_psc_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: glif_cond
+
EndUserDocs */
namespace nest
diff --git a/models/glif_psc.h b/models/glif_psc.h
index cb11214933..420870a4e1 100644
--- a/models/glif_psc.h
+++ b/models/glif_psc.h
@@ -194,6 +194,11 @@ See also
gif_psc_exp_multisynapse, gif_cond_exp, gif_cond_exp_multisynapse, gif_pop_psc_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: glif_psc
+
EndUserDocs */
namespace nest
diff --git a/models/hh_cond_beta_gap_traub.h b/models/hh_cond_beta_gap_traub.h
index f88ea6d2ce..1fe5f30b23 100644
--- a/models/hh_cond_beta_gap_traub.h
+++ b/models/hh_cond_beta_gap_traub.h
@@ -171,6 +171,12 @@ See also
hh_psc_alpha_gap, hh_cond_exp_traub, gap_junction, iaf_cond_beta
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: hh_cond_beta_gap_traub
+
EndUserDocs */
class hh_cond_beta_gap_traub : public ArchivingNode
diff --git a/models/hh_cond_exp_traub.h b/models/hh_cond_exp_traub.h
index d122ddaaea..2637ee11bf 100644
--- a/models/hh_cond_exp_traub.h
+++ b/models/hh_cond_exp_traub.h
@@ -144,6 +144,11 @@ See also
hh_psc_alpha
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: hh_cond_exp_traub
+
EndUserDocs */
class hh_cond_exp_traub : public ArchivingNode
diff --git a/models/hh_psc_alpha.h b/models/hh_psc_alpha.h
index 6a211b6b11..6eeb899933 100644
--- a/models/hh_psc_alpha.h
+++ b/models/hh_psc_alpha.h
@@ -141,6 +141,11 @@ See also
hh_cond_exp_traub
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: hh_psc_alpha
+
EndUserDocs */
class hh_psc_alpha : public ArchivingNode
diff --git a/models/hh_psc_alpha_clopath.h b/models/hh_psc_alpha_clopath.h
index 46610ca0d1..8a8f83917b 100644
--- a/models/hh_psc_alpha_clopath.h
+++ b/models/hh_psc_alpha_clopath.h
@@ -179,6 +179,11 @@ See also
hh_psc_alpha, clopath_synapse, aeif_psc_delta_clopath
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: hh_psc_alpha_clopath
+
EndUserDocs */
class hh_psc_alpha_clopath : public ClopathArchivingNode
diff --git a/models/hh_psc_alpha_gap.h b/models/hh_psc_alpha_gap.h
index 26a11b3633..fd7b2abb45 100644
--- a/models/hh_psc_alpha_gap.h
+++ b/models/hh_psc_alpha_gap.h
@@ -149,6 +149,11 @@ See also
hh_psc_alpha, hh_cond_exp_traub, gap_junction
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: hh_psc_alpha_gap
+
EndUserDocs */
class hh_psc_alpha_gap : public ArchivingNode
diff --git a/models/ht_neuron.h b/models/ht_neuron.h
index 83893efd9d..2d726b96e6 100644
--- a/models/ht_neuron.h
+++ b/models/ht_neuron.h
@@ -180,6 +180,11 @@ See also
ht_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: ht_neuron
+
EndUserDocs */
class ht_neuron : public ArchivingNode
diff --git a/models/ht_synapse.h b/models/ht_synapse.h
index 6e0a47605e..a63539ce33 100644
--- a/models/ht_synapse.h
+++ b/models/ht_synapse.h
@@ -90,6 +90,11 @@ See also
ht_neuron, tsodyks_synapse, stdp_synapse, static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: ht_synapse
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/iaf_chs_2007.h b/models/iaf_chs_2007.h
index 184244cf3e..742fd847fc 100644
--- a/models/iaf_chs_2007.h
+++ b/models/iaf_chs_2007.h
@@ -108,6 +108,11 @@ Receives
SpikeEvent, DataLoggingRequest
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_chs_2007
+
EndUserDocs */
class iaf_chs_2007 : public ArchivingNode
diff --git a/models/iaf_chxk_2008.h b/models/iaf_chxk_2008.h
index 5118b31a67..3a40eecf47 100644
--- a/models/iaf_chxk_2008.h
+++ b/models/iaf_chxk_2008.h
@@ -126,6 +126,11 @@ See also
iaf_cond_alpha
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_chxk_2008
+
EndUserDocs */
/**
diff --git a/models/iaf_cond_alpha.h b/models/iaf_cond_alpha.h
index d59dac16f0..e330e9ad38 100644
--- a/models/iaf_cond_alpha.h
+++ b/models/iaf_cond_alpha.h
@@ -127,6 +127,11 @@ See also
iaf_cond_exp, iaf_cond_alpha_mc
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_cond_alpha
+
EndUserDocs */
class iaf_cond_alpha : public ArchivingNode
diff --git a/models/iaf_cond_alpha_mc.h b/models/iaf_cond_alpha_mc.h
index 5db1eb0ca9..6c9759f496 100644
--- a/models/iaf_cond_alpha_mc.h
+++ b/models/iaf_cond_alpha_mc.h
@@ -168,6 +168,11 @@ See also
iaf_cond_alpha
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_cond_alpha_mc
+
EndUserDocs */
class iaf_cond_alpha_mc : public ArchivingNode
diff --git a/models/iaf_cond_beta.h b/models/iaf_cond_beta.h
index 76a7346806..027cdb2c54 100644
--- a/models/iaf_cond_beta.h
+++ b/models/iaf_cond_beta.h
@@ -146,6 +146,11 @@ See also
iaf_cond_exp, iaf_cond_alpha, iaf_cond_alpha_mc
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_cond_beta
+
EndUserDocs */
class iaf_cond_beta : public ArchivingNode
diff --git a/models/iaf_cond_exp.h b/models/iaf_cond_exp.h
index d12132a9a4..a78eff5340 100644
--- a/models/iaf_cond_exp.h
+++ b/models/iaf_cond_exp.h
@@ -120,6 +120,11 @@ See also
iaf_psc_delta, iaf_psc_exp, iaf_cond_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_cond_exp
+
EndUserDocs*/
class iaf_cond_exp : public ArchivingNode
diff --git a/models/iaf_cond_exp_sfa_rr.h b/models/iaf_cond_exp_sfa_rr.h
index 6a3cfe5efd..66bef76924 100644
--- a/models/iaf_cond_exp_sfa_rr.h
+++ b/models/iaf_cond_exp_sfa_rr.h
@@ -143,6 +143,11 @@ See also
aeif_cond_alpha, aeif_cond_exp, iaf_chxk_2008
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_cond_exp_sfa_rr
+
EndUserDocs */
class iaf_cond_exp_sfa_rr : public ArchivingNode
diff --git a/models/iaf_psc_alpha.h b/models/iaf_psc_alpha.h
index 06db7e4cf6..562a6f65e6 100644
--- a/models/iaf_psc_alpha.h
+++ b/models/iaf_psc_alpha.h
@@ -149,6 +149,12 @@ See also
iaf_psc_delta, iaf_psc_exp, iaf_cond_exp
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_alpha
+
EndUserDocs */
class iaf_psc_alpha : public ArchivingNode
diff --git a/models/iaf_psc_alpha_multisynapse.h b/models/iaf_psc_alpha_multisynapse.h
index efdbc6262b..beabc938bd 100644
--- a/models/iaf_psc_alpha_multisynapse.h
+++ b/models/iaf_psc_alpha_multisynapse.h
@@ -81,6 +81,11 @@ See also
iaf_psc_alpha, iaf_psc_delta, iaf_psc_exp, iaf_cond_exp, iaf_psc_exp_multisynapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_alpha_multisynapse
+
EndUserDocs */
class iaf_psc_alpha_multisynapse : public ArchivingNode
diff --git a/models/iaf_psc_alpha_ps.h b/models/iaf_psc_alpha_ps.h
index dd1e584da7..a18f778ea2 100644
--- a/models/iaf_psc_alpha_ps.h
+++ b/models/iaf_psc_alpha_ps.h
@@ -146,6 +146,11 @@ See also
iaf_psc_alpha, iaf_psc_exp_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_alpha_ps
+
EndUserDocs */
class iaf_psc_alpha_ps : public ArchivingNode
diff --git a/models/iaf_psc_delta.h b/models/iaf_psc_delta.h
index ab8a27ef2f..9afd37a92e 100644
--- a/models/iaf_psc_delta.h
+++ b/models/iaf_psc_delta.h
@@ -124,6 +124,11 @@ See also
iaf_psc_alpha, iaf_psc_exp, iaf_psc_delta_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_delta
+
EndUserDocs */
/**
diff --git a/models/iaf_psc_delta_ps.h b/models/iaf_psc_delta_ps.h
index 6a03dd2e61..cde1f477d6 100644
--- a/models/iaf_psc_delta_ps.h
+++ b/models/iaf_psc_delta_ps.h
@@ -151,6 +151,11 @@ See also
iaf_psc_delta, iaf_psc_exp_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_delta_ps
+
EndUserDocs */
class iaf_psc_delta_ps : public ArchivingNode
diff --git a/models/iaf_psc_exp.h b/models/iaf_psc_exp.h
index 50f0849a80..08dbce9af4 100644
--- a/models/iaf_psc_exp.h
+++ b/models/iaf_psc_exp.h
@@ -157,6 +157,11 @@ See also
iaf_cond_exp, iaf_psc_exp_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_exp
+
EndUserDocs */
/**
diff --git a/models/iaf_psc_exp_htum.h b/models/iaf_psc_exp_htum.h
index 60463bd3a5..badc477ead 100644
--- a/models/iaf_psc_exp_htum.h
+++ b/models/iaf_psc_exp_htum.h
@@ -146,6 +146,11 @@ Receives
SpikeEvent, CurrentEvent, DataLoggingRequest
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_exp_htum
+
EndUserDocs */
class iaf_psc_exp_htum : public ArchivingNode
diff --git a/models/iaf_psc_exp_ps.h b/models/iaf_psc_exp_ps.h
index 44e92163f6..8432da944c 100644
--- a/models/iaf_psc_exp_ps.h
+++ b/models/iaf_psc_exp_ps.h
@@ -140,6 +140,11 @@ See also
iaf_psc_exp, iaf_psc_alpha_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_exp_ps
+
EndUserDocs */
class iaf_psc_exp_ps : public ArchivingNode
diff --git a/models/iaf_psc_exp_ps_lossless.h b/models/iaf_psc_exp_ps_lossless.h
index 379c81ccf3..7855c49b6b 100644
--- a/models/iaf_psc_exp_ps_lossless.h
+++ b/models/iaf_psc_exp_ps_lossless.h
@@ -136,6 +136,11 @@ See also
iaf_psc_exp_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: iaf_psc_exp_ps_lossless
+
EndUserDocs */
class iaf_psc_exp_ps_lossless : public ArchivingNode
diff --git a/models/inhomogeneous_poisson_generator.h b/models/inhomogeneous_poisson_generator.h
index d027321987..c37a9e5eba 100644
--- a/models/inhomogeneous_poisson_generator.h
+++ b/models/inhomogeneous_poisson_generator.h
@@ -95,6 +95,11 @@ See also
sinusoidal_poisson_generator, step_current_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: inhomogeneous_poisson_generator
+
EndUserDocs */
class inhomogeneous_poisson_generator : public StimulationDevice
diff --git a/models/izhikevich.h b/models/izhikevich.h
index 7df407dda7..44183e4c96 100644
--- a/models/izhikevich.h
+++ b/models/izhikevich.h
@@ -122,6 +122,11 @@ See also
iaf_psc_delta, mat2_psc_exp
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: izhikevich
+
EndUserDocs */
class izhikevich : public ArchivingNode
diff --git a/models/jonke_synapse.h b/models/jonke_synapse.h
index 3214d2d3d5..8ba0030e90 100644
--- a/models/jonke_synapse.h
+++ b/models/jonke_synapse.h
@@ -119,6 +119,11 @@ See also
synapsedict, stdp_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: jonke_synapse
+
EndUserDocs */
diff --git a/models/lin_rate.h b/models/lin_rate.h
index 71371dc639..b54c553eb9 100644
--- a/models/lin_rate.h
+++ b/models/lin_rate.h
@@ -124,6 +124,11 @@ See also
rate_connection_instantaneous, rate_connection_delayed,
rate_neuron_ipn, rate_neuron_opn
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: lin_rate
+
EndUserDocs */
class nonlinearities_lin_rate
diff --git a/models/mat2_psc_exp.h b/models/mat2_psc_exp.h
index 09b1b0fdb9..b67df4ba80 100644
--- a/models/mat2_psc_exp.h
+++ b/models/mat2_psc_exp.h
@@ -130,6 +130,11 @@ Receives
SpikeEvent, CurrentEvent, DataLoggingRequest
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: mat2_psc_exp
+
EndUserDocs */
/**
diff --git a/models/mcculloch_pitts_neuron.h b/models/mcculloch_pitts_neuron.h
index 518d59c420..edafb8a7d8 100644
--- a/models/mcculloch_pitts_neuron.h
+++ b/models/mcculloch_pitts_neuron.h
@@ -119,6 +119,11 @@ See also
++++++++
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: mcculloch_pitts_neuron
+
EndUserDocs */
class gainfunction_mcculloch_pitts
diff --git a/models/mip_generator.h b/models/mip_generator.h
index c0a2c50e05..026fe71ced 100644
--- a/models/mip_generator.h
+++ b/models/mip_generator.h
@@ -98,6 +98,11 @@ See also
poisson_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: mip_generator
+
EndUserDocs */
/*! Class mip_generator generates spike trains as described
diff --git a/models/multimeter.h b/models/multimeter.h
index 6b62012e72..2c244fca1a 100644
--- a/models/multimeter.h
+++ b/models/multimeter.h
@@ -124,6 +124,11 @@ interval
See also
++++++++
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: multimeter
+
EndUserDocs */
namespace nest
diff --git a/models/music_cont_in_proxy.h b/models/music_cont_in_proxy.h
index fc9810b861..405c9922aa 100644
--- a/models/music_cont_in_proxy.h
+++ b/models/music_cont_in_proxy.h
@@ -88,6 +88,11 @@ See also
music_event_out_proxy, music_event_in_proxy, music_message_in_proxy
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: music_cont_in_proxy
+
EndUserDocs */
class music_cont_in_proxy : public DeviceNode
diff --git a/models/music_cont_out_proxy.h b/models/music_cont_out_proxy.h
index a4998ab4ee..1d2ce33730 100644
--- a/models/music_cont_out_proxy.h
+++ b/models/music_cont_out_proxy.h
@@ -106,6 +106,11 @@ See also
music_cont_in_proxy, music_event_out_proxy, music_event_in_proxy, music_message_in_proxy
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: music_cont_out_proxy
+
EndUserDocs */
class music_cont_out_proxy : public DeviceNode
diff --git a/models/music_event_in_proxy.h b/models/music_event_in_proxy.h
index 78ba5b6675..4bab54324e 100644
--- a/models/music_event_in_proxy.h
+++ b/models/music_event_in_proxy.h
@@ -85,6 +85,11 @@ See also
SetAcceptableLatency, music_event_out_proxy, music_cont_in_proxy, music_message_in_proxy
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: music_event_in_proxy
+
EndUserDocs */
class music_event_in_proxy : public DeviceNode
diff --git a/models/music_event_out_proxy.h b/models/music_event_out_proxy.h
index f14fe89b0e..5ffb5d2f09 100644
--- a/models/music_event_out_proxy.h
+++ b/models/music_event_out_proxy.h
@@ -84,6 +84,11 @@ See also
music_event_in_proxy, music_cont_in_proxy, music_message_in_proxy
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: music_event_out_proxy
+
EndUserDocs */
class music_event_out_proxy : public DeviceNode
diff --git a/models/music_message_in_proxy.h b/models/music_message_in_proxy.h
index 0095030746..7c0cbde3ac 100644
--- a/models/music_message_in_proxy.h
+++ b/models/music_message_in_proxy.h
@@ -96,6 +96,11 @@ See also
music_event_out_proxy, music_event_in_proxy, music_cont_in_proxy
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: music_message_in_proxy
+
EndUserDocs */
class MsgHandler : public MUSIC::MessageHandler
diff --git a/models/music_rate_in_proxy.h b/models/music_rate_in_proxy.h
index f8436c01da..f51104a34f 100644
--- a/models/music_rate_in_proxy.h
+++ b/models/music_rate_in_proxy.h
@@ -88,6 +88,11 @@ See also
music_rate_out_proxy, music_cont_in_proxy
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: music_rate_in_proxy
+
EndUserDocs*/
namespace nest
diff --git a/models/music_rate_out_proxy.h b/models/music_rate_out_proxy.h
index c4745a03a8..1e48bfda01 100644
--- a/models/music_rate_out_proxy.h
+++ b/models/music_rate_out_proxy.h
@@ -80,6 +80,11 @@ See also
music_rate_in_proxy, music_cont_out_proxy
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: music_rate_out_proxy
+
EndUserDocs */
namespace nest
diff --git a/models/noise_generator.h b/models/noise_generator.h
index f5e954f360..a4bf4f533f 100644
--- a/models/noise_generator.h
+++ b/models/noise_generator.h
@@ -139,6 +139,11 @@ See also
step_current_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: noise_generator
+
EndUserDocs */
class noise_generator : public StimulationDevice
diff --git a/models/parrot_neuron.h b/models/parrot_neuron.h
index bfeea88f4f..8ea9303148 100644
--- a/models/parrot_neuron.h
+++ b/models/parrot_neuron.h
@@ -73,6 +73,11 @@ Sends
SpikeEvent
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: parrot_neuron
+
EndUserDocs */
class parrot_neuron : public ArchivingNode
diff --git a/models/parrot_neuron_ps.h b/models/parrot_neuron_ps.h
index 60c0f291fd..be86995505 100644
--- a/models/parrot_neuron_ps.h
+++ b/models/parrot_neuron_ps.h
@@ -76,6 +76,11 @@ Sends
SpikeEvent
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: parrot_neuron_ps
+
EndUserDocs */
class parrot_neuron_ps : public ArchivingNode
diff --git a/models/poisson_generator.h b/models/poisson_generator.h
index 6fbbec451e..08574a52af 100644
--- a/models/poisson_generator.h
+++ b/models/poisson_generator.h
@@ -75,6 +75,11 @@ See also
poisson_generator_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: poisson_generator
+
EndUserDocs */
class poisson_generator : public StimulationDevice
diff --git a/models/poisson_generator_ps.h b/models/poisson_generator_ps.h
index 78b05831ad..1740b056d4 100644
--- a/models/poisson_generator_ps.h
+++ b/models/poisson_generator_ps.h
@@ -88,6 +88,11 @@ See also
poisson_generator, parrot_neuron_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: poisson_generator_ps
+
EndUserDocs */
class poisson_generator_ps : public StimulationDevice
diff --git a/models/pp_cond_exp_mc_urbanczik.h b/models/pp_cond_exp_mc_urbanczik.h
index c6ef963c27..b811fff8d3 100644
--- a/models/pp_cond_exp_mc_urbanczik.h
+++ b/models/pp_cond_exp_mc_urbanczik.h
@@ -242,6 +242,11 @@ See also
urbanczik_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: pp_cond_exp_mc_urbanczik
+
EndUserDocs */
class pp_cond_exp_mc_urbanczik : public UrbanczikArchivingNode< pp_cond_exp_mc_urbanczik_parameters >
diff --git a/models/pp_psc_delta.h b/models/pp_psc_delta.h
index 8242295949..9501133fcb 100644
--- a/models/pp_psc_delta.h
+++ b/models/pp_psc_delta.h
@@ -190,6 +190,11 @@ See also
iaf_psc_delta, iaf_psc_alpha, iaf_psc_exp, iaf_psc_delta_ps
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: pp_psc_delta
+
EndUserDocs */
class pp_psc_delta : public ArchivingNode
diff --git a/models/ppd_sup_generator.h b/models/ppd_sup_generator.h
index 5548a87966..22e560fe44 100644
--- a/models/ppd_sup_generator.h
+++ b/models/ppd_sup_generator.h
@@ -99,6 +99,11 @@ See also
gamma_sup_generator, poisson_generator_ps, spike_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: ppd_sup_generator
+
EndUserDocs */
class ppd_sup_generator : public StimulationDevice
diff --git a/models/pulsepacket_generator.h b/models/pulsepacket_generator.h
index dd24824324..0e8c523e12 100644
--- a/models/pulsepacket_generator.h
+++ b/models/pulsepacket_generator.h
@@ -93,6 +93,11 @@ See also
spike_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: pulsepacket_generator
+
EndUserDocs */
class pulsepacket_generator : public StimulationDevice
diff --git a/models/rate_connection_instantaneous.h b/models/rate_connection_instantaneous.h
index 8851171bef..1bf92e9968 100644
--- a/models/rate_connection_instantaneous.h
+++ b/models/rate_connection_instantaneous.h
@@ -66,6 +66,11 @@ See also
rate_connection_delayed, rate_neuron_ipn, rate_neuron_opn
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: rate_connection_instantaneous
+
EndUserDocs */
/**
diff --git a/models/rate_neuron_ipn.h b/models/rate_neuron_ipn.h
index 589fd196fb..14c22920ac 100644
--- a/models/rate_neuron_ipn.h
+++ b/models/rate_neuron_ipn.h
@@ -101,6 +101,11 @@ See also
lin_rate, tanh_rate, threshold_lin_rate
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: rate_neuron_ipn
+
EndUserDocs */
template < class TNonlinearities >
diff --git a/models/rate_transformer_node.h b/models/rate_transformer_node.h
index 719c011ad1..50383f18f7 100644
--- a/models/rate_transformer_node.h
+++ b/models/rate_transformer_node.h
@@ -92,6 +92,11 @@ Parameters
Only the parameter ``linear_summation`` and the parameters from the class ``Nonlinearities`` can be set in the
status dictionary.
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: rate_transformer_node
+
EndUserDocs */
template < class TNonlinearities >
diff --git a/models/siegert_neuron.h b/models/siegert_neuron.h
index 7560438765..4fb1c82b5c 100644
--- a/models/siegert_neuron.h
+++ b/models/siegert_neuron.h
@@ -131,6 +131,12 @@ See also
diffusion_connection
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: siegert_neuron
+
EndUserDocs */
class siegert_neuron : public ArchivingNode
diff --git a/models/sigmoid_rate.h b/models/sigmoid_rate.h
index ea93473bd1..3c87a489d4 100644
--- a/models/sigmoid_rate.h
+++ b/models/sigmoid_rate.h
@@ -123,6 +123,12 @@ See also
rate_connection_instantaneous, rate_connection_delayed
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: sigmoid_rate
+
EndUserDocs */
class nonlinearities_sigmoid_rate
diff --git a/models/sigmoid_rate_gg_1998.h b/models/sigmoid_rate_gg_1998.h
index df68d1e631..c7c9900bda 100644
--- a/models/sigmoid_rate_gg_1998.h
+++ b/models/sigmoid_rate_gg_1998.h
@@ -122,6 +122,12 @@ See also
rate_connection_instantaneous, rate_connection_delayed
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: sigmoid_rate_gg_1998
+
EndUserDocs */
class nonlinearities_sigmoid_rate_gg_1998
diff --git a/models/sinusoidal_gamma_generator.h b/models/sinusoidal_gamma_generator.h
index c50c9e6074..277fe9c307 100644
--- a/models/sinusoidal_gamma_generator.h
+++ b/models/sinusoidal_gamma_generator.h
@@ -139,6 +139,12 @@ See also
sinusoidal_poisson_generator, gamma_sup_generator
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: sinusoidal_gamma_generator
+
EndUserDocs */
/**
diff --git a/models/sinusoidal_poisson_generator.h b/models/sinusoidal_poisson_generator.h
index 6a2dcd727b..dd0a1a0348 100644
--- a/models/sinusoidal_poisson_generator.h
+++ b/models/sinusoidal_poisson_generator.h
@@ -119,6 +119,12 @@ See also
poisson_generator, sinusoidal_gamma_generator
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: sinusoidal_poisson_generator
+
EndUserDocs */
class sinusoidal_poisson_generator : public StimulationDevice
diff --git a/models/spike_dilutor.h b/models/spike_dilutor.h
index c6f66f9f07..13127485e3 100644
--- a/models/spike_dilutor.h
+++ b/models/spike_dilutor.h
@@ -76,6 +76,12 @@ See also
mip_generator
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: spike_dilutor
+
EndUserDocs */
class spike_dilutor : public DeviceNode
diff --git a/models/spike_generator.h b/models/spike_generator.h
index f100bd9c1f..e9d6381dd2 100644
--- a/models/spike_generator.h
+++ b/models/spike_generator.h
@@ -225,6 +225,12 @@ See also
poisson_generator, spike_train_injector
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: spike_generator
+
EndUserDocs
*/
class spike_generator : public StimulationDevice
diff --git a/models/spike_recorder.h b/models/spike_recorder.h
index a88af5541c..36da12a386 100644
--- a/models/spike_recorder.h
+++ b/models/spike_recorder.h
@@ -69,6 +69,11 @@ reversed (i.e., connecting *sr* to *neurons*).
See also
++++++++
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: spike_recorder
+
EndUserDocs */
namespace nest
diff --git a/models/spike_train_injector.h b/models/spike_train_injector.h
index 7fc81af294..3e8dd49ec7 100644
--- a/models/spike_train_injector.h
+++ b/models/spike_train_injector.h
@@ -225,6 +225,11 @@ See also
spike_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: spike_train_injector
+
EndUserDocs */
/**
diff --git a/models/spin_detector.h b/models/spin_detector.h
index e46469fa05..72f08acf64 100644
--- a/models/spin_detector.h
+++ b/models/spin_detector.h
@@ -82,6 +82,11 @@ Receives
SpikeEvent
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: spin_detector
+
EndUserDocs */
/**
diff --git a/models/static_synapse.h b/models/static_synapse.h
index 4eb8802013..1993000d1d 100644
--- a/models/static_synapse.h
+++ b/models/static_synapse.h
@@ -53,6 +53,11 @@ See also
tsodyks_synapse, stdp_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: static_synapse
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/static_synapse_hom_w.h b/models/static_synapse_hom_w.h
index 542093834e..a1feaf766d 100644
--- a/models/static_synapse_hom_w.h
+++ b/models/static_synapse_hom_w.h
@@ -59,6 +59,11 @@ See also
static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: static_synpase_hom_w
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/stdp_dopamine_synapse.h b/models/stdp_dopamine_synapse.h
index 3c57618023..bc579a9dfd 100644
--- a/models/stdp_dopamine_synapse.h
+++ b/models/stdp_dopamine_synapse.h
@@ -130,6 +130,11 @@ See also
volume_transmitter
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_dopamine_synapse
+
EndUserDocs */
/**
diff --git a/models/stdp_facetshw_synapse_hom.h b/models/stdp_facetshw_synapse_hom.h
index 69c575ae59..772621331e 100644
--- a/models/stdp_facetshw_synapse_hom.h
+++ b/models/stdp_facetshw_synapse_hom.h
@@ -153,6 +153,11 @@ See also
stdp_synapse, tsodyks_synapse, static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_facetshw_synapse_hom
+
EndUserDocs */
// template class forward declaration required by common properties friend
diff --git a/models/stdp_nn_pre_centered_synapse.h b/models/stdp_nn_pre_centered_synapse.h
index b5ecd58285..12863923ec 100644
--- a/models/stdp_nn_pre_centered_synapse.h
+++ b/models/stdp_nn_pre_centered_synapse.h
@@ -117,6 +117,11 @@ See also
stdp_synapse, stdp_nn_symm_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_nn_pre_centered_synapse
+
EndUserDocs */
// connections are templates of target identifier type (used for pointer /
diff --git a/models/stdp_nn_restr_synapse.h b/models/stdp_nn_restr_synapse.h
index 87c2af8d0f..395c5cdecd 100644
--- a/models/stdp_nn_restr_synapse.h
+++ b/models/stdp_nn_restr_synapse.h
@@ -112,6 +112,11 @@ See also
stdp_synapse, stdp_nn_symm_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_nn_restr_synapse
+
EndUserDocs */
// connections are templates of target identifier type (used for pointer /
diff --git a/models/stdp_nn_symm_synapse.h b/models/stdp_nn_symm_synapse.h
index 0a44d869b3..be8db6784d 100644
--- a/models/stdp_nn_symm_synapse.h
+++ b/models/stdp_nn_symm_synapse.h
@@ -114,6 +114,11 @@ See also
stdp_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_nn_symm_synapse
+
EndUserDocs */
// connections are templates of target identifier type (used for pointer /
diff --git a/models/stdp_pl_synapse_hom.h b/models/stdp_pl_synapse_hom.h
index 58161b2716..6acfcfbd78 100644
--- a/models/stdp_pl_synapse_hom.h
+++ b/models/stdp_pl_synapse_hom.h
@@ -84,6 +84,11 @@ See also
stdp_synapse, tsodyks_synapse, static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_pl_synapse_hom
+
EndUserDocs */
/**
diff --git a/models/stdp_synapse.h b/models/stdp_synapse.h
index 0439ee38a3..1023612214 100644
--- a/models/stdp_synapse.h
+++ b/models/stdp_synapse.h
@@ -104,6 +104,11 @@ See also
tsodyks_synapse, static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_synapse
+
EndUserDocs */
// connections are templates of target identifier type (used for pointer /
diff --git a/models/stdp_synapse_hom.h b/models/stdp_synapse_hom.h
index ec117e88a7..588293140f 100644
--- a/models/stdp_synapse_hom.h
+++ b/models/stdp_synapse_hom.h
@@ -108,6 +108,11 @@ See also
tsodyks_synapse, static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_synapse_hom
+
EndUserDocs */
/**
diff --git a/models/stdp_triplet_synapse.h b/models/stdp_triplet_synapse.h
index e9b48d6bd1..03e2c8d0e2 100644
--- a/models/stdp_triplet_synapse.h
+++ b/models/stdp_triplet_synapse.h
@@ -107,6 +107,12 @@ See also
stdp_triplet_synapse_hpc, stdp_synapse, static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: stdp_triplet_synapse
+
+
EndUserDocs */
// connections are templates of target identifier type
diff --git a/models/step_current_generator.h b/models/step_current_generator.h
index 4feac5294a..18547031ac 100644
--- a/models/step_current_generator.h
+++ b/models/step_current_generator.h
@@ -96,6 +96,11 @@ See also
ac_generator, dc_generator, noise_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: step_current_generator
+
EndUserDocs */
class step_current_generator : public StimulationDevice
diff --git a/models/step_rate_generator.h b/models/step_rate_generator.h
index 138eb7332e..f94ff88a73 100644
--- a/models/step_rate_generator.h
+++ b/models/step_rate_generator.h
@@ -99,6 +99,11 @@ See also
step_current_generator
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: step_rate_generator
+
EndUserDocs */
class step_rate_generator : public StimulationDevice
diff --git a/models/tanh_rate.h b/models/tanh_rate.h
index a1fc17c0dc..7ce634969e 100644
--- a/models/tanh_rate.h
+++ b/models/tanh_rate.h
@@ -117,6 +117,11 @@ See also
rate_connection_instantaneous, rate_connection_delayed
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: tanh_rate
+
EndUserDocs */
class nonlinearities_tanh_rate
diff --git a/models/threshold_lin_rate.h b/models/threshold_lin_rate.h
index 3e13c34ad0..725b2ebc2b 100644
--- a/models/threshold_lin_rate.h
+++ b/models/threshold_lin_rate.h
@@ -121,6 +121,11 @@ See also
rate_connection_instantaneous, rate_connection_delayed
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: threshold_lin_rate
+
EndUserDocs */
class nonlinearities_threshold_lin_rate
diff --git a/models/tsodyks2_synapse.h b/models/tsodyks2_synapse.h
index 232b6d9aba..fa5ae3f2f7 100644
--- a/models/tsodyks2_synapse.h
+++ b/models/tsodyks2_synapse.h
@@ -109,6 +109,11 @@ See also
tsodyks_synapse, stdp_synapse, static_synapse
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: tsodyks2_synapse
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/tsodyks_synapse.h b/models/tsodyks_synapse.h
index 9f54d5ee71..1775135b7e 100644
--- a/models/tsodyks_synapse.h
+++ b/models/tsodyks_synapse.h
@@ -129,6 +129,11 @@ See also
stdp_synapse, static_synapse, iaf_psc_exp, iaf_tum_2000
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: tsodyks_synapse
+
EndUserDocs */
template < typename targetidentifierT >
diff --git a/models/tsodyks_synapse_hom.h b/models/tsodyks_synapse_hom.h
index 7afc5dfb9b..260af44aa3 100644
--- a/models/tsodyks_synapse_hom.h
+++ b/models/tsodyks_synapse_hom.h
@@ -131,6 +131,11 @@ See also
tsodyks_synapse, stdp_synapse_hom, static_synapse_hom_w
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: tsodyks_synapse_hom
+
EndUserDocs */
/**
diff --git a/models/urbanczik_synapse.h b/models/urbanczik_synapse.h
index a116854740..195a38e1b5 100644
--- a/models/urbanczik_synapse.h
+++ b/models/urbanczik_synapse.h
@@ -98,6 +98,11 @@ See also
stdp_synapse, clopath_synapse, pp_cond_exp_mc_urbanczik
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: urbanczik_synapse
+
EndUserDocs */
// connections are templates of target identifier type (used for pointer /
diff --git a/models/vogels_sprekeler_synapse.h b/models/vogels_sprekeler_synapse.h
index 881f63bc43..79e9fd10f8 100644
--- a/models/vogels_sprekeler_synapse.h
+++ b/models/vogels_sprekeler_synapse.h
@@ -77,6 +77,12 @@ References
inhibition in sensory pathways and memory networks. Science,
334(6062):1569-1573. DOI: https://doi.org/10.1126/science.1211095
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: vogels_sprekeler_synapse
+
EndUserDocs */
// connections are templates of target identifier type (used for pointer /
diff --git a/models/volume_transmitter.h b/models/volume_transmitter.h
index 09a8943380..acc06122e9 100644
--- a/models/volume_transmitter.h
+++ b/models/volume_transmitter.h
@@ -99,6 +99,12 @@ See also
stdp_dopamine_synapse
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: volume_transmitter
+
EndUserDocs */
class ConnectorBase;
diff --git a/models/weight_recorder.h b/models/weight_recorder.h
index c5cdd238b4..0fc013c661 100644
--- a/models/weight_recorder.h
+++ b/models/weight_recorder.h
@@ -76,6 +76,12 @@ synapses that fulfill the given criteria.
See also
++++++++
+
+Examples using this model
++++++++++++++++++++++++++
+
+.. listexamples:: weight_recorder
+
EndUserDocs */
namespace nest
diff --git a/pynest/examples/spatial/conncomp.py b/pynest/examples/spatial/conncomp.py
index 6924f28441..2566805a72 100644
--- a/pynest/examples/spatial/conncomp.py
+++ b/pynest/examples/spatial/conncomp.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Pyramidal cells and interneurons
---------------------------------
+Spatial networks: Pyramidal cells and interneurons
+--------------------------------------------------
Create two populations of pyramidal cells and two populations of interneurons
on a 30x30 grid. Connect with two projections, one pyr->pyr, one pyr->in, and
diff --git a/pynest/examples/spatial/conncon_sources.py b/pynest/examples/spatial/conncon_sources.py
index 4201b065fb..15d611b7e5 100644
--- a/pynest/examples/spatial/conncon_sources.py
+++ b/pynest/examples/spatial/conncon_sources.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Convergent projection and rectangular mask, from target perspective
--------------------------------------------------------------------
+Spatial networks: Convergent projection and rectangular mask, from target perspective
+-------------------------------------------------------------------------------------
Create two populations of iaf_psc_alpha neurons on a 30x30 grid
diff --git a/pynest/examples/spatial/conncon_targets.py b/pynest/examples/spatial/conncon_targets.py
index d96f13f7a5..ed85775189 100644
--- a/pynest/examples/spatial/conncon_targets.py
+++ b/pynest/examples/spatial/conncon_targets.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Convergent projection and rectangular mask, from source perspective
---------------------------------------------------------------------
+Spatial networks: Convergent projection and rectangular mask, from source perspective
+-------------------------------------------------------------------------------------
Create two populations of iaf_psc_alpha neurons on a 30x30 grid
Connect the two populations with convergent projection and rectangular mask, and
diff --git a/pynest/examples/spatial/connex.py b/pynest/examples/spatial/connex.py
index dafdb380de..c85bcaa248 100644
--- a/pynest/examples/spatial/connex.py
+++ b/pynest/examples/spatial/connex.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Circular mask and flat probability
-----------------------------------
+Spatial networks: Circular mask and flat probability
+----------------------------------------------------
Create two populations on a 30x30 grid of iaf_psc_alpha neurons,
connect with circular mask, flat probability,
diff --git a/pynest/examples/spatial/connex_ew.py b/pynest/examples/spatial/connex_ew.py
index c73d7cd42e..c2fe05c8b0 100644
--- a/pynest/examples/spatial/connex_ew.py
+++ b/pynest/examples/spatial/connex_ew.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Circular mask and flat probability, with edge wrap
----------------------------------------------------
+Spatial networks: Circular mask and flat probability, with edge wrap
+--------------------------------------------------------------------
Create two populations of iaf_psc_alpha neurons on a 30x30 grid with edge_wrap,
connect with circular mask, flat probability,
diff --git a/pynest/examples/spatial/ctx_2n.py b/pynest/examples/spatial/ctx_2n.py
index c767ada5ff..3e5827f419 100644
--- a/pynest/examples/spatial/ctx_2n.py
+++ b/pynest/examples/spatial/ctx_2n.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-4x3 grid with pyramidal cells and interneurons
-----------------------------------------------
+Spatial networks: 4x3 grid with pyramidal cells and interneurons
+----------------------------------------------------------------
Create a 4x3 grid with one pyramidal cell and one interneuron at each position.
diff --git a/pynest/examples/spatial/gaussex.py b/pynest/examples/spatial/gaussex.py
index 98d474fce7..77ac7cc77b 100644
--- a/pynest/examples/spatial/gaussex.py
+++ b/pynest/examples/spatial/gaussex.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Gaussian probabilistic kernel
------------------------------
+Spatial networks: Gaussian probabilistic kernel
+-----------------------------------------------
Create two populations on a 30x30 grid and connect them using a Gaussian probabilistic kernel
BCCN Tutorial @ CNS*09
diff --git a/pynest/examples/spatial/grid_iaf.py b/pynest/examples/spatial/grid_iaf.py
index 826235cf07..6dd59ce9d5 100644
--- a/pynest/examples/spatial/grid_iaf.py
+++ b/pynest/examples/spatial/grid_iaf.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-4x3 grid
----------
+Spatial networks: 4x3 grid
+--------------------------
Create a population of iaf_psc_alpha neurons on a 4x3 grid.
diff --git a/pynest/examples/spatial/grid_iaf_irr.py b/pynest/examples/spatial/grid_iaf_irr.py
index 9a9924060f..b363194754 100644
--- a/pynest/examples/spatial/grid_iaf_irr.py
+++ b/pynest/examples/spatial/grid_iaf_irr.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Freely placed neurons
-----------------------
+Spatial networks: Freely placed neurons
+---------------------------------------
Create 12 freely placed iaf_psc_alpha neurons.
diff --git a/pynest/examples/spatial/grid_iaf_oc.py b/pynest/examples/spatial/grid_iaf_oc.py
index a4c025f222..26649ef66c 100644
--- a/pynest/examples/spatial/grid_iaf_oc.py
+++ b/pynest/examples/spatial/grid_iaf_oc.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-4x3 grid for three populations
-------------------------------
+Spatial networks: 4x3 grid for three populations
+------------------------------------------------
Create three populations of iaf_psc_alpha neurons on a 4x3 grid, each with different center.
diff --git a/pynest/examples/spatial/nodes_source_target.py b/pynest/examples/spatial/nodes_source_target.py
index e6142cb955..833e14ceae 100644
--- a/pynest/examples/spatial/nodes_source_target.py
+++ b/pynest/examples/spatial/nodes_source_target.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-Showcase of PlotTargets, PlotSources, GetTargetNodes, GetSourceNodes
---------------------------------------------------------------------
+Spatial networks: Showcase of PlotTargets, PlotSources, GetTargetNodes, GetSourceNodes
+--------------------------------------------------------------------------------------
Anno Christopher Kurth, INM-6
"""
diff --git a/pynest/examples/spatial/test_3d.py b/pynest/examples/spatial/test_3d.py
index d5fe3d9d0c..ff6f253b08 100644
--- a/pynest/examples/spatial/test_3d.py
+++ b/pynest/examples/spatial/test_3d.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-A spatial network in 3D
--------------------------
+Spatial networks: A spatial network in 3D
+-----------------------------------------
Hans Ekkehard Plesser, UMB
"""
diff --git a/pynest/examples/spatial/test_3d_exp.py b/pynest/examples/spatial/test_3d_exp.py
index ac734556bc..b7d25c63aa 100644
--- a/pynest/examples/spatial/test_3d_exp.py
+++ b/pynest/examples/spatial/test_3d_exp.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-A spatial network in 3D with exponential connection probabilities
------------------------------------------------------------------
+Spatial networks: A spatial network in 3D with exponential connection probabilities
+-----------------------------------------------------------------------------------
Hans Ekkehard Plesser, UMB
"""
diff --git a/pynest/examples/spatial/test_3d_gauss.py b/pynest/examples/spatial/test_3d_gauss.py
index 5f957defbf..ae31bad926 100644
--- a/pynest/examples/spatial/test_3d_gauss.py
+++ b/pynest/examples/spatial/test_3d_gauss.py
@@ -20,8 +20,8 @@
# along with NEST. If not, see .
"""
-A spatial network in 3D with Gaussian connection probabilities
----------------------------------------------------------------
+Spatial networks: A spatial network in 3D with Gaussian connection probabilities
+--------------------------------------------------------------------------------
Hans Ekkehard Plesser, UMB
"""