Merge pull request #2416 from jessica-mitchell/add-intro-models

Add introductory text for models in documentation

doc/extractor_userdocs.py

@@ -131,7 +131,7 @@ def UserDocExtractor(
             try:
                 doc = rewrite_see_also(doc, filename, tags)
             except ValueError as e:
-                log.warning("Failed to rebuild 'See also' section: %s", e)
+                log.info("Failed to rebuild 'See also' section: %s", e)
             write_rst_files(doc, tags, outdir, outname)
 
     log.info("%4d tags found:\n%s", len(tagdict), pformat(list(tagdict.keys())))
@@ -239,7 +239,7 @@ def rightcase(text):
             secend = nexttitle.start()
         original = doc[secstart:secend].strip().replace('\n', ' ')
         if original:
-            log.warning("dropping manual 'see also' list in %s user docs: '%s'", filename, original)
+            log.info("dropping manual 'see also' list in %s user docs: '%s'", filename, original)
         return (
             doc[:secstart] +
             "\n" + ", ".join([":doc:`{taglabel} <index_{tag}>`".format(tag=tag, taglabel=rightcase(tag))
@@ -344,11 +344,17 @@ def mkitem(t):
 
     output = list()
     if top:
-        page_title = "Model Directory"
+        page_title = "Model directory"
+        description = """
+                       The model directory is organized and autogenerated by keywords (e.g., adaptive threshold,
+                       conductance-based etc.). Models that contain a specific keyword will be listed under that word.
+                       For more information on models, see our :ref:`intro to NEST models <modelsmain>`.
+                       """
         if len(hierarchy.keys()) == 1:
             page_title += ": " + ", ".join(current_tags)
         output.append(page_title)
         output.append(underlines[0]*len(page_title)+"\n")
+        output.append(description + "\n")
         if len(hierarchy.keys()) != 1:
             underlines = underlines[1:]
 

doc/htmldoc/installation/index.rst

@@ -19,7 +19,7 @@ Install NEST
 
 .. grid:: 1 1 2 2
 
-    .. grid-item-card:: |admin| Install NEST for supercomputers and clusters 
+    .. grid-item-card:: |admin| Install NEST for supercomputers and clusters
        :class-title: sd-d-flex-row sd-align-minor-center
 
        I'm an admin or user who wants to :ref:`run NEST on HPC <admin_install>`
@@ -29,8 +29,20 @@ Install NEST
 
        I'm a developer who wants to :ref:`do development in NEST <dev_install>`
 
+.. grid:: 1 1 2 2
+
+    .. grid-item-card:: |nestml| Install NEST with NESTML
+       :class-title: sd-d-flex-row sd-align-minor-center
+
+       I'm a user who wants to :doc:`create or customize models <nestml:installation>`.
+
+|
+
+
+
 ----
 
+
 If installation didn't work, see the :ref:`troubleshooting section <troubleshooting>`.
 
 
@@ -48,3 +60,5 @@ If installation didn't work, see the :ref:`troubleshooting section <troubleshoot
 .. |teacher| image:: ../static/img/014-teacher.svg
 .. |admin| image:: ../static/img/001-shuttle.svg
 .. |dev| image:: ../static/img/dev_orange.svg
+.. |nestml| image:: ../static/img/nestml-logo.png
+      :scale: 15%

doc/htmldoc/installation/lecturer.rst

@@ -17,7 +17,9 @@ There are several materials for Bachelor and Master's level already prepared.
 Docker install
 ~~~~~~~~~~~~~~
 
-We provide a docker container for NEST, with options to include NEST-Desktop, Jupyter notebooks or Jupyterlab.
+We provide a docker container for NEST that also includes NESTML. You can select from options
+to also include NEST-Desktop, Jupyter Notebooks, or JupyterLab.
+
 
 See :ref:`instructions for docker here <docker>`.