.. # - # Copyright 2016 Max Fischer
.. # - #
.. # - # Licensed under the Apache License, Version 2.0 (the "License");
.. # - # you may not use this file except in compliance with the License.
.. # - # You may obtain a copy of the License at
.. # - #
.. # - #     http://www.apache.org/licenses/LICENSE-2.0
.. # - #
.. # - # Unless required by applicable law or agreed to in writing, software
.. # - # distributed under the License is distributed on an "AS IS" BASIS,
.. # - # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. # - # See the License for the specific language governing permissions and
.. # - # limitations under the License.

.. CPy2Py documentation master file, created by
   sphinx-quickstart on Wed Mar 30 13:54:26 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to CPy2Py's documentation!
==================================

To start with :py:mod:`cpy2py`, you should start with the overview pages:

* A quick overview of features is available in the :doc:`README <docs/README>`.
* Key terms are listed in the :doc:`Glossary <docs/definitions>`

Since the API is still being heavily extended, there is not guide or tutorial.
Instead, refer to the examples for various features:

* :doc:`examples/example_function`

The working principles and usage are described in the following topical pages:

* :doc:`docs/objects`
* :doc:`docs/functions`


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

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