Add initial Python bindings documentation
This initial documentation contains a home page, an installation page,
and a few examples to understand how the `bt2` package works.
Still missing: how exactly the bindings wrap libbabeltrace2 (wraping
rules, exceptions, etc.).
Changes:
`README.adoc`:
Specify that you need Sphinx to build the Python bindings
documentation.
`configure.ac` and `m4/check_sphinx.m4`:
Add `--enable-python-bindings-doc` which requires
`--enable-python-bindings`.
This is because the Sphinx configuration file actually imports the
`bt2` package to get the version (and, eventually, for Sphinx's
autodoc to find docstrings within the `bt2` modules).
`doc/bindings/python/source`:
The actual documentation's contents and configuration.
`doc/bindings/python/ext/bt2sphinxurl.py`:
A Sphinx extension to add Babeltrace 2 manual page and other links
of which the URL includes the project's version.
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/3278
Backported from
ba64dfcccb1f1bd7a259dc5d563ba422b8375582
Modifications:
configure.ac:
PPRINT_PROP_BOOL_CUSTOM -> PPRINT_PROP_BOOL
examples.rst:
Removed example usage for `in`:
if 'next_comm' in event:
This utility was introduced by
f03b6364aec2d77bbb5ef0625cbaea8de4179f63, not backported,
and only provides a shortcut to iterate over all `root` fields.
User can implement their own as needed.
Updated referenced version of lttng from 2.11 to "latest" for
lttng-live url.
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: Id0f4636a5f66e98d383548bdcb894f53d31812b4
Reviewed-on: https://review.lttng.org/c/babeltrace/+/3408
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
Tested-by: jenkins <jenkins@lttng.org>