Commit 0b179171f6a4b2de904bf36c6458bebc30906a8f
1 parent
25f4cad1
Cross-link docs from sphinx to doxygen
Showing
3 changed files
with
26 additions
and
3 deletions
doc/Doxyfile
| @@ -1553,7 +1553,7 @@ TAGFILES = | @@ -1553,7 +1553,7 @@ TAGFILES = | ||
| 1553 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create | 1553 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
| 1554 | # a tag file that is based on the input files it reads. | 1554 | # a tag file that is based on the input files it reads. |
| 1555 | 1555 | ||
| 1556 | -GENERATE_TAGFILE = | 1556 | +GENERATE_TAGFILE = doc/html/doxygen/ctools.tag |
| 1557 | 1557 | ||
| 1558 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed | 1558 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
| 1559 | # in the class index. If set to NO only the inherited external classes | 1559 | # in the class index. If set to NO only the inherited external classes |
doc/source/conf.py
| @@ -25,7 +25,14 @@ import sys, os | @@ -25,7 +25,14 @@ import sys, os | ||
| 25 | 25 | ||
| 26 | # Add any Sphinx extension module names here, as strings. They can be extensions | 26 | # Add any Sphinx extension module names here, as strings. They can be extensions |
| 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 28 | -extensions = ['sphinx.ext.mathjax'] | 28 | +try: |
| 29 | + import sphinxcontrib.doxylink | ||
| 30 | + extensions = ['sphinx.ext.mathjax', 'sphinxcontrib.doxylink'] | ||
| 31 | +except: | ||
| 32 | + print('WARNING: Python package `sphinxcontrib.doxylink` not found.\n' | ||
| 33 | + 'WARNING: Please install it to get fully-functional Sphinx docs.\n' | ||
| 34 | + 'WARNING: https://pypi.python.org/pypi/sphinxcontrib-doxylink\n') | ||
| 35 | + extensions = ['sphinx.ext.mathjax'] | ||
| 29 | 36 | ||
| 30 | # Add any paths that contain templates here, relative to this directory. | 37 | # Add any paths that contain templates here, relative to this directory. |
| 31 | templates_path = ['_templates'] | 38 | templates_path = ['_templates'] |
| @@ -241,3 +248,9 @@ texinfo_documents = [ | @@ -241,3 +248,9 @@ texinfo_documents = [ | ||
| 241 | 248 | ||
| 242 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | 249 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
| 243 | #texinfo_show_urls = 'footnote' | 250 | #texinfo_show_urls = 'footnote' |
| 251 | + | ||
| 252 | +# Define connection to Doxygen API docs | ||
| 253 | +# http://pythonhosted.org/sphinxcontrib-doxylink/index.html#confval-doxylink | ||
| 254 | +doxylink = { | ||
| 255 | + 'doxy' : ('doc/html/doxygen/ctools.tag', 'doxygen/'), | ||
| 256 | +} |
doc/source/user_manual/enhancing.rst
| 1 | Enhancing ctools | 1 | Enhancing ctools |
| 2 | ================ | 2 | ================ |
| 3 | 3 | ||
| 4 | +Most ctools users will run the existing ctools or cscripts, | ||
| 5 | +which cover the most common simulation and analysis needs. | ||
| 6 | + | ||
| 7 | +Advanced users and developers can write their own tools and scripts. | ||
| 8 | +The following C++ and Python examples can help get you started: | ||
| 9 | + | ||
| 10 | +* :doxy:`ctlike` | ||
| 11 | +* :doxy:`obsutils` | ||
| 12 | +* :doxy:`cstsdist` | ||
| 13 | + | ||
| 4 | Building your own cscripts | 14 | Building your own cscripts |
| 5 | -------------------------- | 15 | -------------------------- |
| 6 | 16 | ||
| 7 | Building your own ctools | 17 | Building your own ctools |
| 8 | ------------------------- | ||
| 9 | \ No newline at end of file | 18 | \ No newline at end of file |
| 19 | +------------------------ |