JakeHillion/drgn - drgn - Hillion Gitea

JakeHillion/drgn

mirror of https://github.com/JakeHillion/drgn.git synced 2024-12-24 10:03:05 +00:00

2 lines

30 B

ReStructuredText

Raw Normal View History

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

.. autopackage:: drgn.helpers