From 517ae154b340cc9ff60cdaeb7be5928e98532609 Mon Sep 17 00:00:00 2001 From: Sietze van Buuren Date: Tue, 20 Aug 2024 10:29:08 +0200 Subject: [PATCH] docs: Fix links and typos in documentation Signed-off-by: Sietze van Buuren --- docs/examples.md | 5 +++-- docs/getting_started.md | 7 ++++--- docs/introduction.md | 8 +++++--- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index 556ec5e..18e15c2 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,4 +1,5 @@ # Examples -Please refer to the [examples](examples) directory for a series of examples that -illustrate usage of mlpyqtgraph. +Please refer to the +[examples](https://github.com/swvanbuuren/mlpyqtgraph/tree/master/examples) +directory for a series of examples that illustrate usage of mlpyqtgraph. diff --git a/docs/getting_started.md b/docs/getting_started.md index 43c222a..7046037 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -1,13 +1,14 @@ # Getting started To get started using mlpyqtgraph, it first needs to be installed. Refer to -[installation page](Installation) for instructions. +[installation page](../installation.md) for instructions. Now, mlpyqtgraph can be used in existing python programs. To get started, try out the [full -example](https://github.com/swvanbuuren/mlpyqtgraph/blob/main/examples/full.py) -from the [mlpyqtgraph examples](examples). +example](https://github.com/swvanbuuren/mlpyqtgraph/tree/master/examples/full.py) +from the [mlpyqtgraph +examples](https://github.com/swvanbuuren/mlpyqtgraph/tree/master/examples). ```python --8<-- "examples/full.py:6" diff --git a/docs/introduction.md b/docs/introduction.md index 85c868f..35dfaa2 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,11 +1,13 @@ # Introduction mlpyqtgraph enables [matplotlib](https://matplotlib.org/)-like plotting with -|[pyqtgraph](https://github.com/pyqtgraph/pyqtgraph) in existing +[pyqtgraph](https://github.com/pyqtgraph/pyqtgraph) in existing python programs. -It accomplishes this, by offering an interface very similar to |matplotlib|, -while maintaining key |pyqtgraph| features such as speed and interactivity. +It accomplishes this, by offering an interface very similar to +[matplotlib](https://matplotlib.org/), while maintaining key +[pyqtgraph](https://github.com/pyqtgraph/pyqtgraph) features such as speed and +interactivity. mlpyqtgraph diverts the existing python program into a dedicated thread, while using the main thread solely for plotting with pyqtgraph. This is a [requirement