Add initial Python bindings documentation
authorSimon Marchi <simon.marchi@efficios.com>
Thu, 26 Mar 2020 20:33:13 +0000 (16:33 -0400)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Tue, 14 Apr 2020 03:49:18 +0000 (23:49 -0400)
commitba64dfcccb1f1bd7a259dc5d563ba422b8375582
treec041b661a64debd6ed6df3889eca7cb341ee9b47
parentaa7407227594c8e5ebff8e1944a902760f2c9a17
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>
Change-Id: I4811336d567ff379cbe9e789099af8d6c7661a62
Reviewed-on: https://review.lttng.org/c/babeltrace/+/3278
Tested-by: jenkins <jenkins@lttng.org>
13 files changed:
README.adoc
configure.ac
doc/Makefile.am
doc/bindings/Makefile.am [new file with mode: 0644]
doc/bindings/python/Makefile.am [new file with mode: 0644]
doc/bindings/python/ext/bt2sphinxurl.py [new file with mode: 0644]
doc/bindings/python/source/common.rst [new file with mode: 0644]
doc/bindings/python/source/conf.py [new file with mode: 0644]
doc/bindings/python/source/examples.rst [new file with mode: 0644]
doc/bindings/python/source/images/basic-convert-graph.png [new file with mode: 0644]
doc/bindings/python/source/index.rst [new file with mode: 0644]
doc/bindings/python/source/installation.rst [new file with mode: 0644]
m4/check_sphinx.m4 [new file with mode: 0644]
This page took 0.026706 seconds and 4 git commands to generate.