diff --git a/ChangeLog b/ChangeLog index 73661af..d1743b8 100755 --- a/ChangeLog +++ b/ChangeLog @@ -3,6 +3,7 @@ * Version 1.7.0 released ======================== + Add Interface Manual to User documentation (#3163) Adapt show_pull_histogram.py to matplotlib > 3.1.0 (#3156) Avoid negative squared standard deviations in cssrcdetect Update user manual for latest CTA IRF (#3075) diff --git a/NEWS b/NEWS index 08ba3db..272c1f0 100755 --- a/NEWS +++ b/NEWS @@ -16,6 +16,9 @@ None Documentation ------------- +Add Interface Manual to User documentation that provides links to the +ctools and GammaLib Doxygen documentation (#3163). + Update user manual to indicate where to get the latest CTA IRF (#3075). diff --git a/doc/source/admin/release_history/1.7.rst b/doc/source/admin/release_history/1.7.rst index 821ab90..72a54e4 100644 --- a/doc/source/admin/release_history/1.7.rst +++ b/doc/source/admin/release_history/1.7.rst @@ -27,6 +27,8 @@ Bug fixes Improvements ------------ +* [`3163 `_] - + Add Interface Manual to User documentation * [`3075 `_] - Update user manual for latest CTA IRF * [`3065 `_] - diff --git a/doc/source/users/doxygen.rst b/doc/source/users/doxygen.rst new file mode 100755 index 0000000..f7fcdc0 --- /dev/null +++ b/doc/source/users/doxygen.rst @@ -0,0 +1,22 @@ +.. _sec_doxygen: + +Interface Manual +================ + +ctools is comprised of a C++ library that can be accessed from C++ code through +its Application Programming Interface (API). +It can also be accessed from Python through a dedicated module that is generated +using the +`Simplified Wrapper and Interface Generator (SWIG) `_. +ctools comprises also a number of Python scripts, called cscripts, that can be +accessed through a dedicated Python module. +The cscripts are not accessible from C++. + +The documentation of all ctools and cscripts programming interfaces is generated +using `Doxygen `_. Also the GammaLib +programming interfaces are documented via +`Doxygen `_. +Both APIs are accessible through the links below: + +* `ctools interface manual <../doxygen/index.html>`_ +* `GammaLib interface manual `_ diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index aa3223e..f6c01c3 100755 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -11,6 +11,7 @@ This documentation will guide you in the process of using ctools. user_manual/index tutorials/index reference_manual/index + doxygen tips/index user_contributed/index glossary