src/python/docs/index.rst

   1 .. . documentation master file, created by
   2    sphinx-quickstart on Thu May  1 18:34:23 2014.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Welcome to mraa's documentation!
   7 ================================
   8
   9 .. include:: ../../../docs/index.md
  10   :start-after: ==============
  11   :end-before: ## API
  12
  13 .. toctree::
  14    :maxdepth: 2
  15
  16    mraa
  17    example
  18
  19 Supported Platforms
  20 ===================
  21
  22    * `Galileo Gen 1 - Rev D <../galileorevd.html>`_
  23    * `Galileo Gen 2 - Rev H <../galileorevh.html>`_
  24    * `Intel Edison <../edison.html>`_
  25    * `Intel(R) NUC DE3815tykhe <../de3815.html>`_
  26    * `Intel(R) Minnowboard Max <../minnowmax.html>`_
  27    * `Raspberry Pi <../rasspi.html>`_
  28
  29 Compiling & Debugging libmraa
  30 =============================
  31
  32 Libmraa is a C library and SWIG is used to generate bindings therefore to
  33 debug, you very quickly need to use the same methods as you would for debugging
  34 a C library. Generally attaching gdb to python works well, build mraa with
  35 debug symbols and set breakpoints either in the SWIG _wrap functions, the C++
  36 method/functions or the underlying C function. More info can be found on the
  37 C/C++ documentation:
  38    * `Debugging <../debugging.html>`_
  39    * `Building from source <../building.html>`_
  40
  41 API Changelog
  42 =============
  43 .. include:: ../../../docs/index.md
  44   :start-after: API Changelog
  45
  46 Indices and tables
  47 ==================
  48
  49 * :ref:`genindex`
  50 * :ref:`modindex`
  51 * :ref:`search`
  52