Commit 7da6e885471f23dfeb73e210b12e382ddd0a95a9
1 parent
c43856ce
Add Interface Manual to User documentation (#3163)
Showing
5 changed files
with
29 additions
and
0 deletions
ChangeLog
| ... | ... | @@ -3,6 +3,7 @@ |
| 3 | 3 | * Version 1.7.0 released |
| 4 | 4 | ======================== |
| 5 | 5 | |
| 6 | + Add Interface Manual to User documentation (#3163) | |
| 6 | 7 | Adapt show_pull_histogram.py to matplotlib > 3.1.0 (#3156) |
| 7 | 8 | Avoid negative squared standard deviations in cssrcdetect |
| 8 | 9 | Update user manual for latest CTA IRF (#3075) | ... | ... |
NEWS
| ... | ... | @@ -16,6 +16,9 @@ None |
| 16 | 16 | |
| 17 | 17 | Documentation |
| 18 | 18 | ------------- |
| 19 | +Add Interface Manual to User documentation that provides links to the | |
| 20 | +ctools and GammaLib Doxygen documentation (#3163). | |
| 21 | + | |
| 19 | 22 | Update user manual to indicate where to get the latest CTA IRF (#3075). |
| 20 | 23 | |
| 21 | 24 | ... | ... |
doc/source/admin/release_history/1.7.rst
| ... | ... | @@ -27,6 +27,8 @@ Bug fixes |
| 27 | 27 | Improvements |
| 28 | 28 | ------------ |
| 29 | 29 | |
| 30 | +* [`3163 <https://cta-redmine.irap.omp.eu/issues/3163>`_] - | |
| 31 | + Add Interface Manual to User documentation | |
| 30 | 32 | * [`3075 <https://cta-redmine.irap.omp.eu/issues/3075>`_] - |
| 31 | 33 | Update user manual for latest CTA IRF |
| 32 | 34 | * [`3065 <https://cta-redmine.irap.omp.eu/issues/3065>`_] - | ... | ... |
doc/source/users/doxygen.rst
0 → 100755
| 1 | +.. _sec_doxygen: | |
| 2 | + | |
| 3 | +Interface Manual | |
| 4 | +================ | |
| 5 | + | |
| 6 | +ctools is comprised of a C++ library that can be accessed from C++ code through | |
| 7 | +its Application Programming Interface (API). | |
| 8 | +It can also be accessed from Python through a dedicated module that is generated | |
| 9 | +using the | |
| 10 | +`Simplified Wrapper and Interface Generator (SWIG) <http://www.swig.org>`_. | |
| 11 | +ctools comprises also a number of Python scripts, called cscripts, that can be | |
| 12 | +accessed through a dedicated Python module. | |
| 13 | +The cscripts are not accessible from C++. | |
| 14 | + | |
| 15 | +The documentation of all ctools and cscripts programming interfaces is generated | |
| 16 | +using `Doxygen <https://www.doxygen.nl/index.html>`_. Also the GammaLib | |
| 17 | +programming interfaces are documented via | |
| 18 | +`Doxygen <https://www.doxygen.nl/index.html>`_. | |
| 19 | +Both APIs are accessible through the links below: | |
| 20 | + | |
| 21 | +* `ctools interface manual <../doxygen/index.html>`_ | |
| 22 | +* `GammaLib interface manual <http://cta.irap.omp.eu/gammalib/doxygen/index.html>`_ | ... | ... |