Cross-link docs from sphinx to doxygen

Christoph Deil
1 parent 25f4cad1
Showing 3 changed files with 26 additions and 3 deletions
doc/Doxyfile
doc/source/conf.py
doc/source/user_manual/enhancing.rst
@@ -1553,7 +1553,7 @@ TAGFILES               =
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 # a tag file that is based on the input files it reads.
  
-GENERATE_TAGFILE       =
+GENERATE_TAGFILE       = doc/html/doxygen/ctools.tag
  
 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
 # in the class index. If set to NO only the inherited external classes
@@ -25,7 +25,14 @@ import sys, os
  
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.mathjax']
+try:
+    import sphinxcontrib.doxylink
+    extensions = ['sphinx.ext.mathjax', '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']
  
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -241,3 +248,9 @@ texinfo_documents = [
  
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
+
+# Define connection to Doxygen API docs
+# http://pythonhosted.org/sphinxcontrib-doxylink/index.html#confval-doxylink
+doxylink = {
+        'doxy' : ('doc/html/doxygen/ctools.tag', 'doxygen/'),
+}
 Enhancing ctools
 ================
  
+Most ctools users will run the existing ctools or cscripts,
+which cover the most common simulation and analysis needs.
+
+Advanced users and developers can write their own tools and scripts.
+The following C++ and Python examples can help get you started:
+
+* :doxy:`ctlike`
+* :doxy:`obsutils`
+* :doxy:`cstsdist`
+
 Building your own cscripts
 --------------------------
  
 Building your own ctools
-------------------------
 \ No newline at end of file
+------------------------