Add intersphinx_mapping to gammalib

Christoph Deil
1 parent 52162ad1
Showing 2 changed files with 11 additions and 3 deletions
doc/source/conf.py
doc/source/user_manual/getting_started/models.rst
@@ -23,16 +23,17 @@ import sys, os
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
+extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.mathjax']
+
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 try:
     import sphinxcontrib.doxylink
-    extensions = ['sphinx.ext.mathjax', 'sphinxcontrib.doxylink']
+    extensions += ['sphinxcontrib.doxylink']
 except:
     print('WARNING: Python package `sphinxcontrib.doxylink` not found.\n'
           'WARNING: Please install it to get fully-functional Sphinx docs.\n'
           'WARNING: https://pypi.python.org/pypi/sphinxcontrib-doxylink\n')
-    extensions = ['sphinx.ext.mathjax']
 # http://sphinx-doc.org/extensions.html#where-to-put-your-own-extensions
 sys.path.append(os.path.abspath('exts'))
@@ -45,6 +46,12 @@ extensions += [&#39;rawfiles&#39;]
 # output directory by sphinx-build
 rawfiles = ['fhelp']
+# This makes it possible to cross-link to the GammaLib Sphinx docs
+# see http://sphinx-doc.org/ext/intersphinx.html
+intersphinx_mapping = dict()
+intersphinx_mapping['gammalib'] = ('http://gammalib.sourceforge.net/', None)
+
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -2,4 +2,5 @@ Models available in ctools
 --------------------------
 To be written ... (you may read
-http://gammalib.sourceforge.net/user_manual/modules/model.html#spectral-models for the time being).
+:ref:`the model section in the GammaLib user manual <gammalib:sec_model>`
+for the time being).