drgn/docs/index.rst

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
Document with Sphinx drgn has pretty thorough in-program documentation, but it doesn't have a nice overview or introduction to the basic concepts. This commit adds that using Sphinx. In order to avoid documenting everything in two places, the libdrgn bindings have their docstrings generated from the API documentation. The alternative would be to use Sphinx's autodoc extension, but that's not as flexible and would also require building the extension to build the docs. The documentation for the helpers is generated using autodoc and a small custom extension. 2019-04-04 09:27:23 +01:00			`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`
libdrgn: make program components pluggable Currently, programs can be created for three main use-cases: core dumps, the running kernel, and a running process. However, internally, the program memory, types, and symbols are pluggable. Expose that as a callback API, which makes it possible to use drgn in much more creative ways. 2019-05-10 07:53:16 +01:00			`advanced_usage`
Document with Sphinx drgn has pretty thorough in-program documentation, but it doesn't have a nice overview or introduction to the basic concepts. This commit adds that using Sphinx. In order to avoid documenting everything in two places, the libdrgn bindings have their docstrings generated from the API documentation. The alternative would be to use Sphinx's autodoc extension, but that's not as flexible and would also require building the extension to build the docs. The documentation for the helpers is generated using autodoc and a small custom extension. 2019-04-04 09:27:23 +01:00			`api_reference`
			`helpers`