Fix docs build (lhotse-speech#1137)

* Tutorial materials in main readme page

* Fix docs build

* Bump dev version

* Fix missing numpy

* Fix path to VERSION

* Make samplers visible in documentation

Author: pzelasko

.readthedocs.yml

@@ -4,23 +4,20 @@
 
 # Required
 version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+  apt_packages:
+    - "libsndfile-dev"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
-
-# Build documentation with MkDocs
-#mkdocs:
-#  configuration: mkdocs.yml
-
-# Optionally build your docs in additional formats such as PDF
-formats:
-  - pdf
+  configuration: "docs/conf.py"
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
   install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: .
+    - requirements: "docs/requirements.txt"  # install this first to get numpy
+    - method: "pip"
+      path: "."

VERSION

@@ -1 +1 @@
-1.16.0
+1.17.0

docs/conf.py

@@ -23,12 +23,12 @@
 # -- Project information -----------------------------------------------------
 
 project = "lhotse"
-copyright = "2020-2021, Lhotse development team"
+copyright = "2020-2023, Lhotse development team"
 author = "Lhotse development team"
 
 # The full version, including alpha/beta/rc tags
 
-VERSION = open(Path(".").parent / "VERSION").read().strip()
+VERSION = open(Path(__file__).parent.parent.absolute() / "VERSION").read().strip()
 dev_marker = ""
 if not os.environ.get("LHOTSE_PREPARING_RELEASE", False):
     dev_marker = ".dev"

lhotse/dataset/sampling/__init__.py

@@ -7,3 +7,16 @@
 from .stateless import StatelessSampler
 from .utils import find_pessimistic_batches, report_padding_ratio_estimate
 from .zip import ZipSampler
+
+__all__ = [
+    "BucketingSampler",
+    "CutPairsSampler",
+    "DynamicCutSampler",
+    "DynamicBucketingSampler",
+    "RoundRobinSampler",
+    "SimpleCutSampler",
+    "StatelessSampler",
+    "ZipSampler",
+    "find_pessimistic_batches",
+    "report_padding_ratio_estimate",
+]