From d83471ca5daf94f33ba644415c7ded2fda9b89bd Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Sun, 1 Nov 2015 18:59:40 +0100 Subject: [PATCH] Reorganise user documentation. --- doc/source/_templates/index.html | 9 ++++++++- doc/source/_themes/sphinx13/layout.html | 4 ++-- doc/source/about.rst | 6 ++++++ doc/source/contents.rst | 3 ++- doc/source/help.rst | 10 ++++++++++ doc/source/issues.rst | 4 ++-- 6 files changed, 30 insertions(+), 6 deletions(-) create mode 100644 doc/source/help.rst diff --git a/doc/source/_templates/index.html b/doc/source/_templates/index.html index 5a56949..630a2df 100644 --- a/doc/source/_templates/index.html +++ b/doc/source/_templates/index.html @@ -25,6 +25,12 @@ By making use of the GammaLib multi-instrument capabilities, ctools supports the joint analysis of CTA (or any IACT providing data in the CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}

+

{%trans%} ctools are developed by a team of enthousiastic gamma-ray +astronomers with support from engineers. We regularily organise +coding sprints +where key developers but also newcomers meet to discuss the developments +and next steps, and advance with the coding of the software. {%endtrans%}

+

{%trans%} ctools is free software distributed under the GNU GPL license version 3 {%endtrans%}

@@ -52,5 +58,6 @@ CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}

{%trans%}Links{%endtrans%}

diff --git a/doc/source/_themes/sphinx13/layout.html b/doc/source/_themes/sphinx13/layout.html index 8133ca8..407318e 100644 --- a/doc/source/_themes/sphinx13/layout.html +++ b/doc/source/_themes/sphinx13/layout.html @@ -68,15 +68,15 @@
diff --git a/doc/source/about.rst b/doc/source/about.rst index f92cc93..a4e19dc 100644 --- a/doc/source/about.rst +++ b/doc/source/about.rst @@ -27,6 +27,12 @@ By making use of the GammaLib multi-instrument capabilities, ctools supports the joint analysis of CTA (or any IACT providing data in the CTA format), Fermi/LAT and COMPTEL data. +ctools are developed by a team of enthousiastic gamma-ray astronomers with +support from engineers. We regularily organise +`coding sprints `_ +where key developers but also newcomers meet to discuss the developments +and next steps, and advance with the coding of the software. + Acknowledging or citing ctools ------------------------------ diff --git a/doc/source/contents.rst b/doc/source/contents.rst index e9e1af5..b711fca 100644 --- a/doc/source/contents.rst +++ b/doc/source/contents.rst @@ -15,4 +15,5 @@ Documentation reference_manual/index faq issues - develop \ No newline at end of file + develop + help \ No newline at end of file diff --git a/doc/source/help.rst b/doc/source/help.rst new file mode 100644 index 0000000..d3ddeaa --- /dev/null +++ b/doc/source/help.rst @@ -0,0 +1,10 @@ +.. _help: + +Getting Help +============ + +Any questions, bug reports, or suggested enhancements related to +ctools should be submitted via the +`issue tracker `_ +or the +`mailing list `_. \ No newline at end of file diff --git a/doc/source/issues.rst b/doc/source/issues.rst index a752f2e..21552e8 100644 --- a/doc/source/issues.rst +++ b/doc/source/issues.rst @@ -8,7 +8,7 @@ Below you will find a list of known issues. **Installation issues** - :ref:`Certificate problem when cloning from Git ` -- :ref:`Python unit test fail on El Capitan ` +- :ref:`Python unit test fails on El Capitan ` **Analysis issues** @@ -40,7 +40,7 @@ Installation issues .. _issue_elcapitan: -.. topic:: Python unit test fail on El Capitan +.. topic:: Python unit test fails on El Capitan On Mac OS X 10.11 (El Capitan) the Python unit tests fail when ctools are not installed due to the way the ``DYLD_LIBRARY_PATH`` environment -- libgit2 0.21.4