drgn
====

.. include:: ../README.rst
    :start-after: start-introduction
    :end-before: end-introduction

In addition to the main Python API, an experimental C library, ``libdrgn``, is
also available.

See the :doc:`installation` instructions. Then, start with the
:doc:`user_guide`.

.. include:: ../README.rst
    :start-after: start-for-index
    :end-before: end-for-index

Acknowledgements
----------------

drgn is named after `this
<https://giraffesgiraffes.bandcamp.com/track/drgnfkr-2>`_ because dragons eat
`dwarves <http://dwarfstd.org/>`_.

Table of Contents
-----------------

.. toctree::
    :caption: Using drgn
    :maxdepth: 3

    installation
    user_guide
    advanced_usage
    getting_debugging_symbols

.. toctree::
    :caption: Tutorials
    :maxdepth: 3

    tutorials
    case_studies

.. toctree::
    :caption: Reference
    :maxdepth: 3

    api_reference
    helpers
    Man Page <man/drgn>
    support_matrix
    release_highlights
