Skip to content

Commit

Permalink
docs: Fix links and typos in documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Sietze van Buuren <[email protected]>
  • Loading branch information
swvanbuuren committed Aug 20, 2024
1 parent 0ce84e1 commit 517ae15
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
5 changes: 3 additions & 2 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 4 additions & 3 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
8 changes: 5 additions & 3 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 517ae15

Please sign in to comment.