Added links to other component docs

Author: philipstarkey

.gitignore

@@ -136,3 +136,6 @@ dmypy.json
 # conda build results
 conda_build/
 conda_packages/
+
+# dynamically generated docs
+docs/source/component_docs.rst

docs/source/conf.py

@@ -79,12 +79,11 @@
     'matplotlib': ('https://matplotlib.org/', None),
     'h5py': ('http://docs.h5py.org/en/stable/', None),
     'pydaqmx': ('https://pythonhosted.org/PyDAQmx/', None),
-    # from https://github.com/MSLNZ/msl-qt/blob/master/docs/create_pyqt_objects.py
-    # under MIT License
     'qt': (
         '',
         'pyqt5-modified-objects.inv',
-    )
+    )  # from https://github.com/MSLNZ/msl-qt/blob/master/docs/create_pyqt_objects.py
+    # under MIT License
     # TODO
     # desktop-app
     # spinapi/pynivision/etc
@@ -105,7 +104,9 @@
     labscript_suite_programs.remove(project)
 
 # whether to use stable or latest version
-labscript_suite_doc_version = 'stable'  # 'stable' or 'latest'
+labscript_suite_doc_version = os.environ.get('READTHEDOCS_VERSION', 'latest')
+if labscript_suite_doc_version not in ['stable', 'latest']:
+    labscript_suite_doc_version = 'stable'
 
 # add intersphinx references for each component
 for ls_prog in labscript_suite_programs:
@@ -137,6 +138,7 @@
     todo_include_todos = False
 else:
     todo_include_todos = True
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -177,3 +179,22 @@ def setup(app):
     app.add_config_value('m2r_disable_inline_math', False, 'env')
     app.add_directive('mdinclude', MdInclude)
     app.add_stylesheet('custom.css')
+
+    with open(
+        os.path.join(os.path.dirname(os.path.realpath(__file__)), 'component_docs.rst'),
+        'w',
+    ) as f:
+        f.write("labscript suite components\n")
+        f.write("==========================\n")
+        f.write("    \n")
+        f.write(".. toctree::\n")
+        f.write("    :maxdepth: 2\n")
+        f.write("    \n")
+        if project != "the labscript suite":
+            f.write(
+                "    labscript suite (metapackage)<{}>\n".format(
+                    intersphinx_mapping['labscript-suite'][0]
+                )
+            )
+        for ls_prog in labscript_suite_programs:
+            f.write("    {} <{}>\n".format(ls_prog, intersphinx_mapping[ls_prog][0]))

docs/source/index.rst

@@ -13,4 +13,7 @@ This documentation is primarily for developers who might want to use this common
    :maxdepth: 2
 
    api_reference/index
-
+   component_docs
+   Home Page <http://labscriptsuite.org>
+   Source Code <https://github.com/labscript-suite/labscript-suite>
+   BitBucket Archive <http://bitbucket-archive.labscriptsuite.org/#!/labscript_suite/labscript_utils>