Open Programmable Acceleration Engine
=====================================

The main documentation for the site is organized into following sections:

* :ref:`user-docs`
* :ref:`api-docs`
* :ref:`driver-docs`
* :ref:`tools-docs`

.. _user-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE User Guides

   docs/fpga_api/quick_start/readme
   docs/install_guide/installation_guide
   docs/fpga_api/prog_guide/readme
   docs/ase_userguide/ase_userguide

.. _api-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE Libraries

   docs/fpga_api/fpga_api

.. _driver-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE Linux Kernel Drivers

   docs/drv_arch/drv_arch

.. _tools-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE FPGA Tools

   docs/fpga_tools/fpgainfo/fpgainfo
   docs/fpga_tools/fpgaconf/fpgaconf
   docs/fpga_tools/fpgad/fpgad
   docs/fpga_tools/fpgadiag/README
   docs/fpga_tools/mmlink/mmlink
   docs/fpga_tools/userclk/userclk