Commit d83471ca5daf94f33ba644415c7ded2fda9b89bd

Authored by Jürgen Knödlseder
1 parent c898908b

Reorganise user documentation.

doc/source/_templates/index.html
@@ -25,6 +25,12 @@ By making use of the GammaLib multi-instrument capabilities, ctools @@ -25,6 +25,12 @@ By making use of the GammaLib multi-instrument capabilities, ctools
25 supports the joint analysis of CTA (or any IACT providing data in the 25 supports the joint analysis of CTA (or any IACT providing data in the
26 CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}</p> 26 CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}</p>
27 27
  28 +<p>{%trans%} ctools are developed by a team of enthousiastic gamma-ray
  29 +astronomers with support from engineers. We regularily organise
  30 +<a href=https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Coding_sprints>coding sprints</a>
  31 +where key developers but also newcomers meet to discuss the developments
  32 +and next steps, and advance with the coding of the software. {%endtrans%}</p>
  33 +
28 <p>{%trans%} ctools is free software distributed under the 34 <p>{%trans%} ctools is free software distributed under the
29 <a href="http://www.gnu.org/licenses/gpl.html">GNU GPL license version 3</a> {%endtrans%}</p> 35 <a href="http://www.gnu.org/licenses/gpl.html">GNU GPL license version 3</a> {%endtrans%}</p>
30 36
@@ -52,5 +58,6 @@ CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}&lt;/p&gt; @@ -52,5 +58,6 @@ CTA format), Fermi/LAT and COMPTEL data. {%endtrans%}&lt;/p&gt;
52 <h2 style="margin-bottom: 0">{%trans%}Links{%endtrans%}</h2> 58 <h2 style="margin-bottom: 0">{%trans%}Links{%endtrans%}</h2>
53 59
54 <ul> 60 <ul>
55 - <li><a href="https://cta-redmine.irap.omp.eu/projects/ctools">Developer's pages</a>{% endblock %}</li> 61 + <li><a href="https://cta-redmine.irap.omp.eu/projects/ctools">Developer's pages</a></li>
  62 + <li><a href="https://www.openhub.net/p/ctools_">ctools on Open HUB</a>{% endblock %}</li>
56 </ul> 63 </ul>
doc/source/_themes/sphinx13/layout.html
@@ -68,15 +68,15 @@ @@ -68,15 +68,15 @@
68 <div class="pageheader"> 68 <div class="pageheader">
69 <ul> 69 <ul>
70 <li><a href="{{ pathto('about') }}">About</a></li> 70 <li><a href="{{ pathto('about') }}">About</a></li>
71 - <li><a href="{{ pathto('index') }}">Home</a></li>  
72 <li><a href="{{ pathto('download') }}">Download</a></li> 71 <li><a href="{{ pathto('download') }}">Download</a></li>
73 <li><a href="{{ pathto('contents') }}">Documentation</a></li> 72 <li><a href="{{ pathto('contents') }}">Documentation</a></li>
74 <li><a href="{{ pathto('develop') }}">Develop</a></li> 73 <li><a href="{{ pathto('develop') }}">Develop</a></li>
  74 + <li><a href="{{ pathto('help') }}">Help</a></li>
75 </ul> 75 </ul>
76 <div> 76 <div>
77 <a href="{{ pathto('index') }}"> 77 <a href="{{ pathto('index') }}">
78 <div class=banner_part> 78 <div class=banner_part>
79 - <img src="{{ pathto('_static/logo.png', 1) }}" height="64" alt="SPHINX" /> 79 + <img src="{{ pathto('_static/logo.png', 1) }}" height="64" alt="ctools" />
80 </div> 80 </div>
81 <div class=banner_part></div> 81 <div class=banner_part></div>
82 <div class=banner_part></div> 82 <div class=banner_part></div>
doc/source/about.rst
@@ -27,6 +27,12 @@ By making use of the GammaLib multi-instrument capabilities, ctools @@ -27,6 +27,12 @@ By making use of the GammaLib multi-instrument capabilities, ctools
27 supports the joint analysis of CTA (or any IACT providing data in the 27 supports the joint analysis of CTA (or any IACT providing data in the
28 CTA format), Fermi/LAT and COMPTEL data. 28 CTA format), Fermi/LAT and COMPTEL data.
29 29
  30 +ctools are developed by a team of enthousiastic gamma-ray astronomers with
  31 +support from engineers. We regularily organise
  32 +`coding sprints <https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Coding_sprints>`_
  33 +where key developers but also newcomers meet to discuss the developments
  34 +and next steps, and advance with the coding of the software.
  35 +
30 36
31 Acknowledging or citing ctools 37 Acknowledging or citing ctools
32 ------------------------------ 38 ------------------------------
doc/source/contents.rst
@@ -15,4 +15,5 @@ Documentation @@ -15,4 +15,5 @@ Documentation
15 reference_manual/index 15 reference_manual/index
16 faq 16 faq
17 issues 17 issues
18 - develop  
19 \ No newline at end of file 18 \ No newline at end of file
  19 + develop
  20 + help
20 \ No newline at end of file 21 \ No newline at end of file
doc/source/help.rst 0 → 100644
  1 +.. _help:
  2 +
  3 +Getting Help
  4 +============
  5 +
  6 +Any questions, bug reports, or suggested enhancements related to
  7 +ctools should be submitted via the
  8 +`issue tracker <https://cta-redmine.irap.omp.eu/projects/ctools/issues/new>`_
  9 +or the
  10 +`mailing list <mailto:ctools@irap.omp.eu>`_.
0 \ No newline at end of file 11 \ No newline at end of file
doc/source/issues.rst
@@ -8,7 +8,7 @@ Below you will find a list of known issues. @@ -8,7 +8,7 @@ Below you will find a list of known issues.
8 **Installation issues** 8 **Installation issues**
9 9
10 - :ref:`Certificate problem when cloning from Git <issue_ssl>` 10 - :ref:`Certificate problem when cloning from Git <issue_ssl>`
11 -- :ref:`Python unit test fail on El Capitan <issue_elcapitan>` 11 +- :ref:`Python unit test fails on El Capitan <issue_elcapitan>`
12 12
13 **Analysis issues** 13 **Analysis issues**
14 14
@@ -40,7 +40,7 @@ Installation issues @@ -40,7 +40,7 @@ Installation issues
40 40
41 .. _issue_elcapitan: 41 .. _issue_elcapitan:
42 42
43 -.. topic:: Python unit test fail on El Capitan 43 +.. topic:: Python unit test fails on El Capitan
44 44
45 On Mac OS X 10.11 (El Capitan) the Python unit tests fail when ctools 45 On Mac OS X 10.11 (El Capitan) the Python unit tests fail when ctools
46 are not installed due to the way the ``DYLD_LIBRARY_PATH`` environment 46 are not installed due to the way the ``DYLD_LIBRARY_PATH`` environment