Merge pull request #1477 from JSchripsema-IDM/intersphinx

Intersphinx addition for linking to other packages' docs

README.md

@@ -32,7 +32,7 @@
 
 # User Installation
 
-See Private documentation is located at https://docs.idmod.org/projects/idmtools/en/latest/. Scroll to "Do you have a password? Access here" and use the password "IDM2020idmtools".  for complete documentation
+Documentation is located at https://docs.idmod.org/projects/idmtools/en/latest/. 
 
 ## Recommended install
 

docs/conf.py

@@ -45,7 +45,8 @@
     'sphinx.ext.todo',
     'plantweb.directive',
     'sphinxcontrib.programoutput',
-    'sphinx_copybutton'
+    'sphinx_copybutton',
+    'sphinx.ext.intersphinx'
 ]
 
 plantuml = 'plantweb'
@@ -57,8 +58,7 @@
 }
 
 autodoc_mock_imports = ['pika',
-                        'dramatiq'
-                        ]
+                        'dramatiq']
 
 
 napoleon_google_docstring = True
@@ -388,4 +388,9 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-# intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
+                       'emod_api': ('https://docs.idmod.org/projects/emod-api/en/latest/', None),
+                       'emodpy': ('https://docs.idmod.org/projects/emodpy/en/latest/', None),
+                       'pycomps': ('https://docs.idmod.org/projects/pycomps/en/latest/', None)
+                       }
+

docs/index.rst

@@ -8,7 +8,10 @@ from the creation of input files (if required), to calibration of the model to d
 and running simulations, through the analysis of results. Modelers can use |IT_s| to run models
 locally or send suites of simulations to an HPC or other computing source. This framework is
 free, open-source, and model agnostic: it can be used to interact with a variety of models,
-such as custom models written in R or Python, or IDM's own |EMOD_s|.
+such as custom models written in R or Python, or IDM's own |EMOD_s|. Additional functionality 
+for interacting with |EMOD_s| is provided in the :doc:`emod_api:emod_api_index` and 
+:doc:`emodpy:emodpy_index` packages.
+
 
 
 |IT_s| workflow