
Kompute Docs Home
==========================================

High Level Overview (from README)
--------

.. mdinclude:: ../README.md


Documentation Index (as per sidebar)
--------

.. toctree::
    :titlesonly:
    :caption: C++ Documentation:

    Documentation Home <https://kompute.cc/>
    Community Meetings, Discord & Links <overview/community>

.. toctree::
    :titlesonly:
    :caption: C++ Documentation:

    C++ Examples <overview/advanced-examples>
    Memory Management Principles <overview/memory-management>
    Build System Deep Dive <overview/build-system>
    Processing Shaders (Online & Offline) <overview/shaders-to-headers>
    Extending Kompute with Custom Operations <overview/custom-operations>
    C++ Class Documentation & Reference <overview/reference>
    Test Code Coverage <https://kompute.cc/codecov/>

.. toctree::
    :titlesonly:
    :caption: Python Documentation:

    Python Package Overview <overview/python-package>
    Python Class Documentation & Reference <overview/python-reference>

.. toctree::
    :titlesonly:
    :caption: Examples:

    Python Examples <overview/python-examples>
    C++ Examples <overview/advanced-examples>
    Android Mobile App Integration <overview/mobile-android>
    Edge Device Raspberry Pi Mesa Drivers <overview/raspberry-pi>
    Game Engine Godot Integration <overview/game-engine-godot>
    Example Benchmark with Matrix Multiplication <overview/matmul-benchmark>
    Convolutional Neural Network (CNN) Simple Upscale <overview/convolutional-net>

.. toctree::
    :titlesonly:
    :caption: Advanced Concepts & Deep Dives:

    CI, Docker Images Docs & Tests <overview/ci-tests>
    Variable Types for Tensors, and Push/Spec Constants <overview/variable-types>
    Asynchronous & Parallel Operations <overview/async-parallel>
    Code Index <genindex>
