Skip to content

Commit d93ef9c

Browse files
committed
Add link to ReadTheDocs
1 parent b917fb7 commit d93ef9c

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Python ctypes-based bindings for libvlc
1+
# Python ctypes-based bindings generator for libvlc
22

33
![](https://img.shields.io/github/actions/workflow/status/oaubert/python-vlc/tests.yml?event=push&label=tests)
44
[![](https://readthedocs.org/projects/python-vlc/badge/)](https://python-vlc.readthedocs.org/)
55
[![Join the chat at https://discord.gg/3h3K3JF](https://img.shields.io/discord/716939396464508958?label=discord)](https://discord.gg/3h3K3JF)
66

77
This file documents the bindings generator, not the bindings
8-
themselves. For the bindings documentation, see the README.module
9-
file.
8+
themselves. For the bindings documentation, see the
9+
[README.module](README.module) file.
1010

1111
The bindings generator generates ctypes-bindings from the include
1212
files defining the public API. The same generated module should be

README.module

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ Using the module
1818
----------------
1919

2020
The module offers two ways of accessing the API - a raw access to all
21-
exported methods, and more convenient wrapper classes.
21+
exported methods, and more convenient wrapper classes. The [API
22+
documentation](https://python-vlc.readthedocs.io/en/latest/) is
23+
on Readthedocs.
2224

2325
Using wrapper classes
2426
+++++++++++++++++++++

0 commit comments

Comments
 (0)