summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2024-02-05 17:14:14 +0100
committerJeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com>2024-02-19 14:15:07 +0100
commit88244b18d28d4af37bfb3284ddcda7cc93c50dde (patch)
tree1c4c43c13538b700b2858575a5889354676dcab4 /docs
parente159e88117250903e772ba33b7395ac9f35a95c2 (diff)
Docs API: Add autogenerated note
Diffstat (limited to 'docs')
-rw-r--r--docs/src/api/wheretofinddocs.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/src/api/wheretofinddocs.md b/docs/src/api/wheretofinddocs.md
index cbf4a67..f4ad5bf 100644
--- a/docs/src/api/wheretofinddocs.md
+++ b/docs/src/api/wheretofinddocs.md
@@ -1,5 +1,5 @@
# 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.
+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 it is available as autogenerated form [here](./functiondocs.md).
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).