Welcome in the PyROS developer documentation
============================================

.. |br| raw:: html

   <br />


.. image:: ./doc_images/logo-irap-couleur-1024x386.png
	:height: 100px
	:align: center

|br|
|br|

+------------------------------+------------------------------------------------------------------+
| | IRAP                       | | Project Scientist (PI) : Alain Klotz - aklotz AT irap.omp.eu   |
| | 9 Avenue Colonel Roche     | | Project Manager : Etienne Pallier - epallier AT irap.omp.eu    |
| | 31028 Toulouse Cedex 4     | | Developper : Alexis Koralewski - akoralewski AT irap.omp.eu    |
| | FRANCE                     | | http://pyros.irap.omp.eu                                       |
+------------------------------+------------------------------------------------------------------+

.. warning:: This project is under active development.

.. note::
   This project is under active development.


1. PyROS files
--------------

See in the `Installation documentation - Project structure <https://docs.google.com/document/d/1DjT_rAzeVPl9SnQG3_20GFbDf67JEUAsOD1uhDMlOVw/edit#heading=h.19nwnkgoi5k>`_

.. comments
    .. toctree:: 
       :maxdepth: 3
        
       using_mount_classes


2. PyROS general configuration
------------------------------

See in the `Execution & Configuration documentation - General Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.q3s2zb7c303n>`_



3. Observatory configuration
----------------------------

See in the `Execution & Configuration documentation - Observatory Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.ec6uvlb3rto4>`_



4. PyROS API Source Code documentation
--------------------------------------

.. The PyROS :doc:`Packages, Classes, and Methods<generated_api/pyros_django_package>`



5. Guitastro package documentation
----------------------------------

See in the `Guitastro documentation <../../../../vendor/guitastro/doc_rst/build/html/index.html>`_


6. PyROS Python source code style recommandations
-------------------------------------------------

:doc:`generated_api/codestyle_examples_package`

.. image:: doc_images/generated/packages_codestyle_examples.png
.. image:: doc_images/generated/classes_codestyle_examples.png



=====================================================================================



.. COMMENT: The toctree directive is mainly to let Sphinx be aware of the document hierarchy (the sidebar will reflect this understanding)


.. toctree:: 
    :maxdepth: 1
    :caption: Contents:

    generated_api/codestyle_examples_package

.. generated_api/pyros_django_package



.. comment    guitastro

.. comment    `Guitastro documentation <../../../vendor/guitastro/doc_rst/build/html/index.html>`_

.. comment    ../../../vendor/guitastro/doc_rst/source/index

.. Generation doc guitastro API directement depuis ce script (EP) :
..    generated_api/guitastro_package

.. Autres modules :
..   device_controller_package
..   pyros_django_package
..   autodoc_pyros
..   pyros-doc-DEV
..   modules

=====================================================================================


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`

.. * :ref:`search`