From 0ddb6a1224988e669c3a075de713adb32f22f6c9 Mon Sep 17 00:00:00 2001 From: Sietze van Buuren Date: Sun, 10 Nov 2024 12:31:34 +0100 Subject: [PATCH] docs: Add info and resolution for missing xcb plugin error Signed-off-by: Sietze van Buuren --- docs/installation.md | 21 ++++++++++++++++++++- mkdocs.yml | 7 ++++++- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 85fd365..4eaf7f4 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -28,4 +28,23 @@ pip install /path/to/mlpyqtgraph ``` Now, mpyqtgraph can be used whenever the appropriate virtual environment has -been activated. +been activated e.g., by trying the [minimal example](https://github.com/swvanbuuren/mlpyqtgraph/blob/master/examples/minimal.py): + +```bash +python examples/minimal.py +``` + +!!! info + + If you receive an error message similar to the following: + + ```plaintext + Could not load the Qt platform plugin "xcb" in "" even though it was found." + ``` + + Then, you might need to install additional dependencies. On a Debian-based + system, this is accomplished with: + + ```bash + sudo apt install -y libxcb-cursor-dev + ``` diff --git a/mkdocs.yml b/mkdocs.yml index e271263..98f3c15 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,7 @@ theme: - navigation.sections - navigation.tabs - navigation.indexes + - content.code.annotate - content.code.copy plugins: @@ -21,6 +22,9 @@ plugins: markdown_extensions: - attr_list + - md_in_html + - admonition + - pymdownx.details - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg @@ -29,7 +33,8 @@ markdown_extensions: line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - - pymdownx.snippets + - pymdownx.snippets: + url_download: true - pymdownx.superfences