Addressing latest review comments

Author: philipstarkey

docs/source/_templates/components.rst

@@ -3,7 +3,7 @@
     :maxdepth: 2
     :hidden:
 
-    The labscript suite <{{intersphinx_mapping['labscript-suite'][0]}}>
+    the labscript suite <{{intersphinx_mapping['labscript-suite'][0]}}>
 
 {% endif %}
 *labscript suite* components
@@ -16,7 +16,7 @@ The *labscript suite* is modular by design, and is comprised of:
     :header-rows: 0
 
     {% for prog, item in programs.items() if item.type == 'lib' %}
-    * - .. image:: {{item.img}}
+    * - .. image:: {{img_path}}/{{item.icon}}
              :target: {{intersphinx_mapping['%s' | format(prog)][0]}}
              :class: labscript-suite-icon
       - |{{prog}}|_ --- {{item.desc}}
@@ -27,7 +27,7 @@ The *labscript suite* is modular by design, and is comprised of:
     :header-rows: 0
 
     {% for prog, item in programs.items() if item.type == 'gui' %}
-    * - .. image:: {{item.img}}
+    * - .. image:: {{img_path}}/{{item.icon}}
              :target: {{intersphinx_mapping['%s' | format(prog)][0]}}
              :class: labscript-suite-icon
       - |{{prog}}|_ --- {{item.desc}}

docs/source/conf.py

@@ -95,37 +95,37 @@
 labscript_suite_programs = {
     'labscript': {
         'desc': 'Expressive composition of hardware-timed experiments',
-        'img': img_path + '/labscript_32nx32n.svg',
+        'icon': 'labscript_32nx32n.svg',
         'type': 'lib',
     },
     'labscript-devices': {
         'desc': 'Plugin architecture for controlling experiment hardware',
-        'img': img_path + '/labscript_32nx32n.svg',
+        'icon': 'labscript_32nx32n.svg',
         'type': 'lib',
     },
     'labscript-utils': {
         'desc': 'Shared modules used by the *labscript suite*',
-        'img': img_path + '/labscript_32nx32n.svg',
+        'icon': 'labscript_32nx32n.svg',
         'type': 'lib',
     },
     'runmanager': {
         'desc': 'Graphical and remote interface to parameterized experiments',
-        'img': img_path + '/runmanager_32nx32n.svg',
+        'icon': 'runmanager_32nx32n.svg',
         'type': 'gui',
     },
     'blacs': {
         'desc': 'Graphical interface to scientific instruments and experiment supervision',
-        'img': img_path + '/blacs_32nx32n.svg',
+        'icon': 'blacs_32nx32n.svg',
         'type': 'gui',
     },
     'lyse': {
         'desc': 'Online analysis of live experiment data',
-        'img': img_path + '/lyse_32nx32n.svg',
+        'icon': 'lyse_32nx32n.svg',
         'type': 'gui',
     },
     'runviewer': {
         'desc': 'Visualize hardware-timed experiment instructions',
-        'img': img_path + '/runviewer_32nx32n.svg',
+        'icon': 'runviewer_32nx32n.svg',
         'type': 'gui',
     },
 }
@@ -217,5 +217,6 @@ def setup(app):
                 intersphinx_mapping=intersphinx_mapping,
                 programs=labscript_suite_programs,
                 current_project=project,
+                img_path=img_path
             )
         )

docs/source/index.rst

@@ -3,14 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-``labscript`` documentation
-===========================
-``labscript``, a component of the labscript suite, is an API used to define the experiment logic of a buffered experiment shot. This documentation will outline the general device hierarchy used when defining a connection table, and the ``labscript`` classes used to command input and output. For device specific documentation, and documentation for adding support for new devices, please refer to the :doc:`labscript-devices <labscript-devices:index>` documentation.
+labscript
+=========
+**labscript**, a component of the labscript suite, is an API used to define the experiment logic of a buffered experiment shot. This documentation will outline the general device hierarchy used when defining a connection table, and the **labscript** classes used to command input and output. For device specific documentation, and documentation for adding support for new devices, please refer to the :doc:`labscript-devices <labscript-devices:index>` documentation.
 
 
 .. toctree::
    :maxdepth: 2
    :hidden:
+   :caption: DOCUMENTATION
 
    introduction
    connection_table
@@ -30,6 +31,8 @@
 
    Home Page <http://labscriptsuite.org>
    Source Code <https://github.com/labscript-suite/labscript>
+   PyPI <https://pypi.org/project/labscript/>
+   Anaconda Cloud <https://anaconda.org/labscript-suite/labscript>
    BitBucket Archive <http://bitbucket-archive.labscriptsuite.org/#!/labscript_suite/labscript>
 
 .. todolist::