JakeHillion/drgn

Fork 0

mirror of https://github.com/JakeHillion/drgn.git synced 2024-12-27 02:45:53 +00:00

Commit Graph

Author	SHA1	Message	Date
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

Author

SHA1

Message

Date

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

3 Commits