Commit Graph

6 Commits

Author SHA1 Message Date
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
fbbc7c55a2 Add logo and favicon 2019-04-17 01:16:31 -07:00
Omar Sandoval
452901923b docs: document creating incomplete type with struct_type()
This got lost in the conversion to Sphinx.
2019-04-12 16:46:07 -07:00
Omar Sandoval
1b4aee1a55 libdrgn/python: add Program.pointer_type() 2019-04-11 23:35:10 -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