.. Futhark documentation master file, created by
   sphinx-quickstart on Tue Mar 24 14:21:12 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Futhark User's Guide
====================

Welcome to the documentation for the Futhark compiler and language.
For a basic introduction, please see `the Futhark website
<http://futhark-lang.org>`_.  To get started, read the page on
:ref:`installation`.  Once the compiler has been installed, you might
want to take a look at :ref:`usage`.  This User's Guide contains a
:ref:`language-reference`, but new Futhark programmers are probably
better served by reading `Parallel Programming in Futhark
<https://futhark-book.readthedocs.io>`_ first.

Documentation for the built-in prelude is also `available online
<https://futhark-lang.org/docs/prelude/>`_.

The particularly interested reader may also want to peruse the
`publications <https://futhark-lang.org/docs.html#publications>`_, or
the `development blog <https://futhark-lang.org/blog.html>`_.

.. toctree::
   :caption: Table of Contents
   :maxdepth: 2
   :numbered:

   installation.rst
   usage.rst
   language-reference.rst
   c-api.rst
   js-api.rst
   package-management.rst
   performance.rst
   error-index.rst
   server-protocol.rst
   c-porting-guide.rst
   versus-other-languages.rst
   binary-data-format.rst
   glossary.rst

.. toctree::
   :caption: Manual Pages
   :maxdepth: 1

   man/futhark-autotune.rst
   man/futhark-bench.rst
   man/futhark-c.rst
   man/futhark-cuda.rst
   man/futhark-dataset.rst
   man/futhark-doc.rst
   man/futhark-fmt.rst
   man/futhark-hip.rst
   man/futhark-ispc.rst
   man/futhark-literate.rst
   man/futhark-script.rst
   man/futhark-multicore.rst
   man/futhark-opencl.rst
   man/futhark-pkg.rst
   man/futhark-profile.rst
   man/futhark-pyopencl.rst
   man/futhark-python.rst
   man/futhark-repl.rst
   man/futhark-run.rst
   man/futhark-test.rst
   man/futhark-wasm-multicore.rst
   man/futhark-wasm.rst
   man/futhark.rst
