From 3f323d61c8767eeac2d48b564770a0b7aeda18fc Mon Sep 17 00:00:00 2001 From: Amir MOHAMMADI <amir.mohammadi@idiap.ch> Date: Thu, 3 Mar 2022 14:39:05 +0100 Subject: [PATCH] mention this package is deprecated --- doc/extra-intersphinx.txt | 2 -- doc/index.rst | 7 ++++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/doc/extra-intersphinx.txt b/doc/extra-intersphinx.txt index a3920bd..4a36b0b 100644 --- a/doc/extra-intersphinx.txt +++ b/doc/extra-intersphinx.txt @@ -1,4 +1,2 @@ scipy -bob.io.audio bob.io.image -bob.io.video diff --git a/doc/index.rst b/doc/index.rst index a1027db..c24f651 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -7,7 +7,10 @@ Bob's Core I/O Routines ========================= -This package is a part of `Bob`_. +This package is a part of `Bob`_ and is deprecated!!! +Please use ``h5py``, ``scipy.io.wavfile``, ``imageio``, ``imageio-ffmpeg`` instead. +Below is the old documentation. + This module contains a basic interface to read and write files of various types. It provides generic functions :py:func:`bob.io.base.save` and :py:func:`bob.io.base.load` to write and read various types of data. In this @@ -15,9 +18,7 @@ interface, data is mainly written using the :py:class:`bob.io.base.HDF5File` interface. To enable further types of IO, please import one of the following packages (the list might not be exhaustive): -* :ref:`bob.io.audio` to load and save audio data of various kinds * :ref:`bob.io.image` to load and save images of various kinds -* :ref:`bob.io.video` to load and save videos of various types Documentation -- GitLab