Update documentation

neuml · Sep 20, 2024 · 4f55ffb · 4f55ffb
1 parent 748998d
commit 4f55ffb
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 3 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -12,6 +12,7 @@ jobs:
         with:
           python-version: 3.8
       - run: |
+          sudo apt-get update && sudo apt-get install libsndfile1 portaudio19-dev
           pip install -U pip wheel
           pip install .[all,dev]
       - run: mkdocs gh-deploy --force

diff --git a/docker/base/Dockerfile b/docker/base/Dockerfile
@@ -21,7 +21,7 @@ ENV LANG=C.UTF-8
 RUN \
     # Install required packages
     apt-get update && \
-    apt-get -y --no-install-recommends install libgomp1 libsndfile1 gcc g++ python${PYTHON_VERSION} python${PYTHON_VERSION}-dev python3-pip && \
+    apt-get -y --no-install-recommends install libgomp1 libsndfile1 portaudio19-dev gcc g++ python${PYTHON_VERSION} python${PYTHON_VERSION}-dev python3-pip && \
     rm -rf /var/lib/apt/lists && \
     \
     # Install txtai project and dependencies

diff --git a/docs/install.md b/docs/install.md
@@ -130,12 +130,14 @@ Additional environment specific prerequisites are below.
 
 ### Linux
 
-Optional audio transcription requires a [system library to be installed](https://github.com/bastibe/python-soundfile#installation)
+The AudioStream and Microphone pipelines require the [PortAudio](https://people.csail.mit.edu/hubert/pyaudio) system library. The Transcription pipeline requires the [SoundFile](https://github.com/bastibe/python-soundfile#installation) system library.
 
 ### macOS
 
 Older versions of Faiss have a runtime dependency on `libomp` for macOS. Run `brew install libomp` in this case.
 
+The AudioStream and Microphone pipelines require the [PortAudio](https://people.csail.mit.edu/hubert/pyaudio) system library.
+
 ### Windows
 
 Optional dependencies require [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)

diff --git a/docs/pipeline/audio/audiostream.md b/docs/pipeline/audio/audiostream.md
@@ -17,6 +17,8 @@ audio = AudioStream()
 audio(data)
 ```
 
+This pipeline may require additional system dependencies. See [this section](../../../install#environment-specific-prerequisites) for more.
+
 ## Configuration-driven example
 
 Pipelines are run with Python or configuration. Pipelines can be instantiated in [configuration](../../../api/configuration/#pipeline) using the lower case name of the pipeline. Configuration-driven pipelines are run with [workflows](../../../workflow/#configuration-driven-example) or the [API](../../../api#local-instance).

diff --git a/docs/pipeline/audio/microphone.md b/docs/pipeline/audio/microphone.md
@@ -17,6 +17,8 @@ microphone = Microphone()
 microphone()
 ```
 
+This pipeline may require additional system dependencies. See [this section](../../../install#environment-specific-prerequisites) for more.
+
 ## Configuration-driven example
 
 Pipelines are run with Python or configuration. Pipelines can be instantiated in [configuration](../../../api/configuration/#pipeline) using the lower case name of the pipeline. Configuration-driven pipelines are run with [workflows](../../../workflow/#configuration-driven-example) or the [API](../../../api#local-instance).

diff --git a/docs/pipeline/audio/transcription.md b/docs/pipeline/audio/transcription.md
@@ -17,6 +17,8 @@ transcribe = Transcription()
 transcribe("path to wav file")
 ```
 
+This pipeline may require additional system dependencies. See [this section](../../../install#environment-specific-prerequisites) for more.
+
 See the link below for a more detailed example.
 
 | Notebook  | Description  |       |

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -37,7 +37,7 @@ plugins:
     - mkdocstrings:
         handlers:
             python:
-                rendering:
+                options:
                     show_root_full_path: false
                     show_root_heading: true
                     show_root_toc_entry: false