Commit Graph

7 Commits

Author SHA1 Message Date
Omar Sandoval
f4822be904 Document PyPI package and installation with pip 2020-01-23 15:15:33 -08:00
Omar Sandoval
18dfec083e docs: update local installation directions
Now that the CLI references the distribution, one needs to create the
distribution metadata to run locally.
2020-01-23 14:04:46 -08:00
Omar Sandoval
6a13d74c0c libdrgn: build with bundled elfutils
Now that we have the bundled version of elfutils, build it from libdrgn
and link to it. We can also get rid of the elfutils version checks from
the libdrgn code.
2019-09-19 11:07:12 -07:00
Serapheim Dimitropoulos
93d7ea9f01 Add support for kdump-compressed core dumps with libkdumpfile 2019-08-02 00:20:16 -07:00
Omar Sandoval
ce74f3fee1 docs: document Python 3 development header dependency 2019-05-03 10:23:02 -07:00
Omar Sandoval
3e1f31ed37 docs: document GNU Make dependency
I assumed installing autotools would pull this in, by at least on a
fresh Fedora install, it doesn't.
2019-05-03 09:56:36 -07:00
Omar Sandoval
393a1f3149 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-11 12:48:15 -07:00