From 88244b18d28d4af37bfb3284ddcda7cc93c50dde Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Mon, 5 Feb 2024 17:14:14 +0100 Subject: Docs API: Add autogenerated note --- docs/src/api/wheretofinddocs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') 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). -- cgit v1.2.3