docs/source/index.rst

.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements.  See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership.  The ASF licenses this file
.. to you 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.

.. image:: _static/images/DataFusionComet-Logo-Light.png
  :alt: DataFusion Comet Logo

=======================
Apache DataFusion Comet
=======================

.. Code from https://buttons.github.io/
.. raw:: html

  <p>
    <!-- Place this tag where you want the button to render. -->
    <a class="github-button" href="https://github.com/apache/datafusion-comet" data-size="large" data-show-count="true" aria-label="Star apache/datafusion-comet on GitHub">Star</a>
    <!-- Place this tag where you want the button to render. -->
     <a class="github-button" href="https://github.com/apache/datafusion-comet/fork" data-size="large" data-show-count="true" aria-label="Fork apache/datafusion-comet on GitHub">Fork</a>
  </p>

Apache DataFusion Comet is an Apache Spark plugin that uses Apache DataFusion
as a native runtime to achieve improvement in terms of query efficiency and query runtime.

.. _toc.user-guide-links:
.. toctree::
   :maxdepth: 1
   :caption: User Guide

   Comet Overview <user-guide/overview>
   Installing Comet <user-guide/installation>
   Building From Source <user-guide/source>
   Kubernetes Guide <user-guide/kubernetes>
   Supported Data Sources <user-guide/datasources>
   Supported Data Types <user-guide/datatypes>
   Supported Operators <user-guide/operators>
   Supported Expressions <user-guide/expressions>
   Configuration Settings <user-guide/configs>
   Compatibility Guide <user-guide/compatibility>
   Tuning Guide <user-guide/tuning>
   Metrics Guide <user-guide/metrics>

.. _toc.contributor-guide-links:
.. toctree::
   :maxdepth: 1
   :caption: Contributor Guide

   Getting Started <contributor-guide/contributing>
   Comet Plugin Overview <contributor-guide/plugin_overview>
   Development Guide <contributor-guide/development>
   Debugging Guide <contributor-guide/debugging>
   Benchmarking Guide <contributor-guide/benchmarking>
   Adding a New Expression <contributor-guide/adding_a_new_expression>
   Tracing <contributor-guide/tracing>
   Profiling Native Code <contributor-guide/profiling_native_code>
   Spark SQL Tests <contributor-guide/spark-sql-tests.md>
   Github and Issue Tracker <https://github.com/apache/datafusion-comet>

.. _toc.asf-links:
.. toctree::
   :maxdepth: 1
   :caption: ASF Links

   Apache Software Foundation <https://apache.org>
   License <https://www.apache.org/licenses/>
   Donate <https://www.apache.org/foundation/sponsorship.html>
   Thanks <https://www.apache.org/foundation/thanks.html>
   Security <https://www.apache.org/security/>
   Code of conduct <https://www.apache.org/foundation/policies/conduct.html>