X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=doc%2Fbindings%2Fpython%2Fsource%2Findex.rst;fp=doc%2Fbindings%2Fpython%2Fsource%2Findex.rst;h=0000000000000000000000000000000000000000;hp=fc02e8d18fbd137d803e86119339e890cfdb5724;hb=48ba910c442105da68c0f9bb703213517409f863;hpb=5cea295bfb45e7e7b495a5d9812b9a0522c3f743 diff --git a/doc/bindings/python/source/index.rst b/doc/bindings/python/source/index.rst deleted file mode 100644 index fc02e8d1..00000000 --- a/doc/bindings/python/source/index.rst +++ /dev/null @@ -1,73 +0,0 @@ -########################################### -Babeltrace |version| legacy Python bindings -########################################### - -Generated on |today|. - - -Welcome! -======== - -Welcome to `Babeltrace `_'s -*legacy* Python bindings' documentation! - -Babeltrace is a trace format converter. It is able to read and write -different trace formats, such as the -`Common Trace Format `_ (CTF). -Babeltrace also acts as the CTF reference implementation. - -The Babeltrace legacy Python bindings rely on the ``libbabeltrace`` -library, the public C API of Babeltrace. - - -Installing -========== - -The bindings may be enabled when configuring Babeltrace's build:: - - ./configure --enable-python-bindings - -On Debian and Ubuntu, the bindings are available in the -``python3-babeltrace`` package. - -.. note:: - - Currently, the Babeltrace legacy Python bindings only works - with Python 3. - - -Bindings -======== - -The Babeltrace legacy Python bindings are available as a single Python -package, :py:mod:`babeltrace`. - -The Babeltrace legacy Python bindings' API is divided into two parts: - -* The :ref:`reader API ` is exposed by the - :mod:`babeltrace.reader` module, a set of classes used to - open a collection of different traces and iterate on their events. -* The :ref:`CTF writer API ` is exposed by the - :mod:`babeltrace.writer` module, which makes it possible to - write a complete `CTF `_ trace from - scratch. - -.. note:: - - For backward compatibility reasons, the reader API is imported in the - package itself. The CTF writer API is imported in the package itself - too, as :mod:`~babeltrace.CTFWriter`. It is, however, strongly - recommended to import and use the three modules - (:mod:`babeltrace.common`, :mod:`babeltrace.reader`, and - :mod:`babeltrace.writer`) explicitly, since there is no long-term - plan to maintain the compatibility layer. - -**Contents**: - -.. toctree:: - :numbered: - - constants - reader - writer - examples