Home | History | Annotate | Download | only in docs
      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 <../rasppi.html>`_
     28    * `Banana Pi/Pro <../bananapi.html>`_
     29    * `Beaglebone Black <../beaglebone.html>`_
     30    * `Intel NUC NUC5i5MYBE <../nuc5.html>`_
     31    * `FTDI FT4222H <../ft4222.html>`_
     32 
     33 Compiling & Debugging libmraa
     34 =============================
     35 
     36 Libmraa is a C library and SWIG is used to generate bindings therefore to
     37 debug, you very quickly need to use the same methods as you would for debugging
     38 a C library. Generally attaching gdb to python works well, build mraa with
     39 debug symbols and set breakpoints either in the SWIG _wrap functions, the C++
     40 method/functions or the underlying C function. More info can be found on the
     41 C/C++ documentation:
     42    * `Debugging <../debugging.html>`_
     43    * `Building from source <../building.html>`_
     44 
     45 API Changelog
     46 =============
     47 .. include:: ../../../docs/index.md
     48   :start-after: API Changelog
     49 
     50 Indices and tables
     51 ==================
     52 
     53 * :ref:`genindex`
     54 * :ref:`modindex`
     55 * :ref:`search`
     56 
     57