.. kerrpy documentation master file, created by
   sphinx-quickstart on Wed Aug 10 14:00:40 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to kerrpy's documentation!
==================================

Contents:

.. toctree::
   :maxdepth: 4
    
   kerrpy


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

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


Testing
=======

.. .. currentmodule:: kerrpy 

.. autoclass:: kerrpy.camera.Camera
    :noindex:
    :members:

.. autoclass:: kerrpy.raytracer.RayTracer
    :noindex:
    :members:


This is a test to know whether the figure automatic numbering really works. See :numref:`my-figure-ref` if everything's fine.

.. _my-figure-ref:
.. figure:: ../images/sphinxTest.png
   :scale: 50 %
   :alt: map to buried treasure

   This is the caption of the figure (a simple paragraph).

   The legend consists of all elements after the caption.  In this
   case, the legend consists of this paragraph and the following
   table.

Doxygen testing
===============

.. doxygenfile:: solvers.cu
.. doxygenfile:: raytracer.cu
.. doxygenfile:: image_transformation.cu
.. doxygenfile:: functions.cu

doxygenfunction:: advanceStep

Bibliography
============

.. bibliography:: ../Bibliography.bib