summaryrefslogtreecommitdiff
path: root/docs/src/api/wheretofinddocs.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2023-05-01 14:19:32 +0200
committerJeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com>2023-09-25 09:43:37 +0200
commitd4939e8694a6762dc9de2f4027266850f49790ac (patch)
tree89545f23dbb74766ed42dd1824c59eae35f26800 /docs/src/api/wheretofinddocs.md
parentc654b48763592baae78b10f6fefec10be29e979b (diff)
Docs: Update API section for V2
Diffstat (limited to 'docs/src/api/wheretofinddocs.md')
-rw-r--r--docs/src/api/wheretofinddocs.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/src/api/wheretofinddocs.md b/docs/src/api/wheretofinddocs.md
new file mode 100644
index 0000000..cbf4a67
--- /dev/null
+++ b/docs/src/api/wheretofinddocs.md
@@ -0,0 +1,6 @@
+# Where to find API docs
+The API documentation, depends on which wrapper you are using. If you're writing a wrapper yourself, or want some background information on how it works internally, you can find function docs in the [exports/exports.go](https://github.com/eduvpn/eduvpn-common/blob/v2/exports/exports.go) file.
+
+This file is commented using Go comment style. It gives a basic of what the function does, what it returns and what type of arguments you should pass to it. The API documentation for the Python wrapper can be [found here](https://eduvpn.github.io/eduvpn-common/api/python/rtd/index.html).
+
+There is also a Go API that is defined in the [client package](https://github.com/eduvpn/eduvpn-common/tree/v2/client). However, this is not the primary use case for the library.