drgn/docs/index.rst
Omar Sandoval 8358c31d26 docs: document how to get debugging symbols
I couldn't find any good summaries of how to get debugging symbols on
various distros, so I guess we'll have to maintain our own.

Signed-off-by: Omar Sandoval <osandov@osandov.com>
2021-11-02 17:48:36 -07:00

41 lines
766 B
ReStructuredText

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`.
License
-------
.. include:: ../README.rst
:start-after: start-license
:end-before: end-license
Acknowledgements
----------------
drgn is named after `this
<https://giraffesgiraffes.bandcamp.com/track/drgnfkr-2>`_ because dragons eat
`dwarves <http://dwarfstd.org/>`_.
Table of Contents
-----------------
.. toctree::
:maxdepth: 3
installation
user_guide
advanced_usage
api_reference
helpers
case_studies
getting_debugging_symbols