Reorganise documentation tree

Jürgen Knödlseder
1 parent f1c51a69
Showing 21 changed files with 81 additions and 77 deletions
doc/source/_templates/index.html
doc/source/_themes/sphinx13/layout.html
doc/source/download.rst → doc/source/admin/download.rst
doc/source/admin/index.rst
doc/source/users/installation.rst → doc/source/admin/install.rst
doc/source/users/release_history/1.0.1.rst → doc/source/admin/release_history/1.0.1.rst
doc/source/users/release_history/1.0.rst → doc/source/admin/release_history/1.0.rst
doc/source/users/release_history/1.1.rst → doc/source/admin/release_history/1.1.rst
doc/source/users/release_history/1.2.rst → doc/source/admin/release_history/1.2.rst
doc/source/users/release_history/1.3.rst → doc/source/admin/release_history/1.3.rst
doc/source/users/release_history/index.rst → doc/source/admin/release_history/index.rst
doc/source/contents.rst
doc/source/users/faq.rst → doc/source/help/faq.rst
doc/source/users/help.rst → doc/source/help/index.rst
doc/source/users/issues.rst → doc/source/help/issues.rst
doc/source/users/howto/index.rst
doc/source/users/howto/sky.rst → doc/source/users/howto/sky/convert_coordinates.rst
doc/source/users/howto/sky/convert_projections.rst
doc/source/users/howto/sky/index.rst
doc/source/users/index.rst
@@ -28,29 +28,4 @@ and next steps, and advance with the coding of the software. {%endtrans%}&lt;/p&gt;
 <p>{%trans%} GammaLib is free software distributed under the
 <a href="http://www.gnu.org/licenses/gpl.html">GNU GPL license version 3</a> {%endtrans%}</p>
  
-<h2 style="margin-bottom: 0">{%trans%}Getting started{%endtrans%}</h2>
-
-<ul>
-<li><a class="smalllink" href="{{ pathto("users/installation") }}">{%trans%}Installation{%endtrans%}</a></li>
-<li><a class="smalllink" href="{{ pathto("users/quickstart") }}">{%trans%}Quickstart{%endtrans%}</a></li>
-</ul>
-
-<h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2>
-
-<ul>
-<li><a class="smalllink" href="{{ pathto("users/user_manual/index") }}">{%trans%}User Manual{%endtrans%}</a></li>
-<li><a class="smalllink" href="{{ pathto("users/howto/index") }}">{%trans%}How To{%endtrans%}</a></li>
-<li><a class="smalllink" href="{{ pathto("users/faq") }}">{%trans%}Frequently asked questions{%endtrans%}</a></li>
-<li><a class="smalllink" href="{{ pathto("users/issues") }}">{%trans%}Known issues{%endtrans%}</a></li>
-<li><a class="smalllink" href="{{ pathto("users/release_history/index") }}">{%trans%}Release history{%endtrans%}</a></li>
-<li><a class="smalllink" href="doxygen/index.html">{%trans%}Source code documentation (Doxygen){%endtrans%}</a></li>
-</ul>
-
-<h2 style="margin-bottom: 0">{%trans%}Links{%endtrans%}</h2>
-
-<ul>
-	<li><a href="https://cta-gitlab.irap.omp.eu/gammalib/gammalib">GitLab</a></li>
-	<li><a href="https://github.com/gammalib/gammalib">GitHub</a></li>
-	<li><a href="https://cta-redmine.irap.omp.eu/projects/gammalib">Redmine</a></li>
-	<li><a href="https://www.openhub.net/p/GammaLib">Open HUB</a>{% endblock %}</li>
-</ul>
+{% endblock %}
@@ -69,10 +69,10 @@
 <div class="pageheader">
   <ul>
     <li><a href="{{ pathto('about') }}">About</a></li>
-    <li><a href="{{ pathto('download') }}">Download</a></li>
+    <li><a href="{{ pathto('admin/index') }}">Getting GammaLib</a></li>
     <li><a href="{{ pathto('users/index') }}">For Users</a></li>
     <li><a href="{{ pathto('develop/index') }}">For Developers</a></li>
-    <li><a href="{{ pathto('users/help') }}">Help</a></li>
+    <li><a href="{{ pathto('help/index') }}">Help</a></li>
   </ul>
   <div>
     <a href="{{ pathto('index') }}">
-.. _download:
+.. _sec_download:
  
 Download
 ========
@@ -92,7 +92,7 @@ the following command sequence (the code will be installed into the
    $ export GAMMALIB=/usr/local/gamma
    $ source $GAMMALIB/bin/gammalib-init.sh
  
-Please read the :ref:`installation` section if you need more information on
+Please read the :ref:`sec_installation` section if you need more information on
 how to install GammaLib.
  
 .. note::
+.. _sec_admin:
+
+Getting GammaLib
+================
+
+.. toctree::
+   :maxdepth: 1
+
+   download
+   install
+   release_history/index
+
-.. _installation:
+.. _sec_installation:
  
 Installation
 ============
+.. _sec_contents:
+
 Documentation
 =============
  
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 1
  
    about
-   download
+   admin/index
    users/index
    develop/index
+   help/index
@@ -3,8 +3,16 @@
 Getting Help
 ============
  
+If you need help you should first check
+
+.. toctree::
+   :maxdepth: 1
+
+   faq
+   issues
+
 Any questions, bug reports, or suggested enhancements related to
 GammaLib should be submitted via the
 `issue tracker <https://cta-redmine.irap.omp.eu/projects/gammalib/issues/new>`_
 or the
-`mailing list <mailto:ctools@irap.omp.eu>`_.
 \ No newline at end of file
+`mailing list <mailto:ctools@irap.omp.eu>`_.
@@ -3,8 +3,8 @@ How To
 ======
  
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
  
-   sky
+   sky/index
  
  
-Sky coordinates, sky maps and sky regions
------------------------------------------
+.. _sec_sky_convert_coordinates:
  
 How to convert a sky coordinate from celestial to Galactic?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+===========================================================
  
 To convert from celestial to Galactic coordinates you can set a sky 
 direction in celestial coordinates and read it back in Galactic
@@ -30,33 +29,3 @@ C++:
     double l = dir.l_deg();
     double b = dir.b_deg();
     std::cout << l << ", " << b << std::endl;
-
-
-How to convert sky map projections?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following code illustrates how to convert a map in HealPix projection
-into a map in cartesian projection. Map conversion is performed using the
-+= operator that adds the bilinearly interpolated intensity values from one
-map to another. The example code applies to any kind of map projections.
-
-Python:
-
-.. code-block:: python
-
-    >>> import gammalib
-    >>> healpix = gammalib.GSkyMap("healpix.fits")
-    >>> map = gammalib.GSkyMap("CAR","GAL",0.0,0.0,0.5,0.5,100,100)
-    >>> map += healpix
-    >>> map.save("carmap.fits")
-
-C++:
-
-.. code-block:: cpp
-
-    #include "GammaLib.hpp"
-    GSkyMap healpix("healpix.fits");
-    GSkyMap map("CAR","GAL",0.0,0.0,0.5,0.5,100,100);
-    map += healpix;
-    map.save("carmap.fits");
-    
 \ No newline at end of file
+.. _sec_sky_convert_projections:
+
+How to convert sky map projections?
+===================================
+
+The following code illustrates how to convert a map in HealPix projection
+into a map in cartesian projection. Map conversion is performed using the
++= operator that adds the bilinearly interpolated intensity values from one
+map to another. The example code applies to any kind of map projections.
+
+Python:
+
+.. code-block:: python
+
+    >>> import gammalib
+    >>> healpix = gammalib.GSkyMap("healpix.fits")
+    >>> map = gammalib.GSkyMap("CAR","GAL",0.0,0.0,0.5,0.5,100,100)
+    >>> map += healpix
+    >>> map.save("carmap.fits")
+
+C++:
+
+.. code-block:: cpp
+
+    #include "GammaLib.hpp"
+    GSkyMap healpix("healpix.fits");
+    GSkyMap map("CAR","GAL",0.0,0.0,0.5,0.5,100,100);
+    map += healpix;
+    map.save("carmap.fits");
+    
+.. _sec_howto_sky:
+
+Sky coordinates, sky maps and sky regions
+-----------------------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   convert_coordinates
+   convert_projections
-.. _users:
+.. _sec_users:
  
 User Documentation
 ==================
  
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
  
-   installation
    quickstart
    user_manual/index
    howto/index
-   faq
-   issues
-   release_history/index
-   help
+.. _sec_user_manual:
+
 ===========
 User Manual
 ===========
  
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
  
    introduction
    getting