==========
GALFITools
==========

A library for `GALFIT`_


..  This is the main page of your project's `Sphinx`_ documentation.
    It is formatted in `reStructuredText`_. Add additional pages
    by creating rst-files in ``docs`` and adding them to the `toctree`_ below.
    Use then `references`_ in order to link them from this page, e.g.
    :ref:`authors` and :ref:`changes`.

    It is also possible to refer to the documentation of other Python packages
    with the `Python domain syntax`_. By default you can reference the
    documentation of `Sphinx`_, `Python`_, `NumPy`_, `SciPy`_, `matplotlib`_,
    `Pandas`_, `Scikit-Learn`_. You can add more by extending the
    ``intersphinx_mapping`` in your Sphinx's ``conf.py``.

    The pretty useful extension `autodoc`_ is activated by default and lets
    you include documentation from docstrings. Docstrings can be written in
    `Google style`_ (recommended!), `NumPy style`_ and `classical style`_.


.. admonition:: Audience
   :class: note

   GALFITools is designed for researchers and students working with
   galaxy images who wish to streamline their use of GALFIT. While
   familiarity with Python is assumed, no advanced astronomy background
   is required. Key terms are defined in the :doc:`concepts` section, and
   tutorials are available in the :doc:`usage` guide.


Contents
========

.. toctree::
   :maxdepth: 2

   Overview <readme>
   Statement of need <statement>
   Concepts <concepts>
   Usage guide <usage>
   API Reference <api>
   Module Reference <api/modules>
   Contributions & Help <contributing>
   License <license>
   Authors <authors>
   Changelog <changelog>

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

* :ref:`genindex`
* :doc:`Overview <readme>`
* :doc:`Concepts <concepts>`
* :ref:`usage`
* :ref:`api`
* :ref:`modindex`
* :ref:`search`



.. _GALFIT: https://users.obs.carnegiescience.edu/peng/work/galfit/galfit.html

.. _toctree: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _references: https://www.sphinx-doc.org/en/stable/markup/inline.html
.. _Python domain syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain
.. _Sphinx: https://www.sphinx-doc.org/
.. _Python: https://docs.python.org/
.. _Numpy: https://numpy.org/doc/stable
.. _SciPy: https://docs.scipy.org/doc/scipy/reference/
.. _matplotlib: https://matplotlib.org/contents.html#
.. _Pandas: https://pandas.pydata.org/pandas-docs/stable
.. _Scikit-Learn: https://scikit-learn.org/stable
.. _autodoc: https://www.sphinx-doc.org/en/master/ext/autodoc.html
.. _Google style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
.. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
.. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists
.. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists