diff options
Diffstat (limited to 'docs/src/api/wheretofinddocs.md')
| -rw-r--r-- | docs/src/api/wheretofinddocs.md | 6 |
1 files changed, 0 insertions, 6 deletions
diff --git a/docs/src/api/wheretofinddocs.md b/docs/src/api/wheretofinddocs.md deleted file mode 100644 index cda485f..0000000 --- a/docs/src/api/wheretofinddocs.md +++ /dev/null @@ -1,6 +0,0 @@ -# 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://codeberg.org/eduVPN/eduvpn-common/src/branch/main/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). - -There is also a Go API that is defined in the [client package](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/client). However, this is not the primary use case for the library. |