diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2024-11-21 15:57:12 +0100 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2024-11-21 16:06:22 +0100 |
| commit | a587163c822e80527f6acc78c1edac3410327854 (patch) | |
| tree | 15ddd4ee5e2f7af01eeef98fb4adc4bd6c651776 /docs/src/api | |
| parent | 72edbfe5d2d51b7dbaaa6ac6fe96cfbd43b60069 (diff) | |
Replace all links from GitHub to Codeberg
Diffstat (limited to 'docs/src/api')
| -rw-r--r-- | docs/src/api/codeexamples.md | 2 | ||||
| -rw-r--r-- | docs/src/api/letsbuildaclient.md | 2 | ||||
| -rw-r--r-- | docs/src/api/statemachine.md | 2 | ||||
| -rw-r--r-- | docs/src/api/wheretofinddocs.md | 4 |
4 files changed, 5 insertions, 5 deletions
diff --git a/docs/src/api/codeexamples.md b/docs/src/api/codeexamples.md index b3bcdc3..f47e99f 100644 --- a/docs/src/api/codeexamples.md +++ b/docs/src/api/codeexamples.md @@ -2,7 +2,7 @@ This chapter contains code examples that use the API ## Go command line client -The following is an example [in the repository](https://github.com/eduvpn/eduvpn-common/blob/v2/cmd/cli/main.go). It is a command line client with the following flags +The following is an example [in the repository](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/cmd/cli/main.go). It is a command line client with the following flags ``` -get-custom string The url of a custom server to connect to diff --git a/docs/src/api/letsbuildaclient.md b/docs/src/api/letsbuildaclient.md index b675ee0..e513157 100644 --- a/docs/src/api/letsbuildaclient.md +++ b/docs/src/api/letsbuildaclient.md @@ -110,7 +110,7 @@ Note that this state transition is essentially the same as the following code: ```python -def handler(old: int, new: int, data: str): -- # it's 6 because https://github.com/eduvpn/eduvpn-common/blob/b660911b5db000b43970f3754b5767bb50741360/client/fsm.go#L33 +- # it's 6 because https://codeberg.org/eduVPN/eduvpn-common/src/commit/b660911b5db000b43970f3754b5767bb50741360/client/fsm.go#L33 - if new == 6: - webbrowser.open(data) - return True diff --git a/docs/src/api/statemachine.md b/docs/src/api/statemachine.md index 57ca775..953bf2b 100644 --- a/docs/src/api/statemachine.md +++ b/docs/src/api/statemachine.md @@ -90,7 +90,7 @@ The current state is highlighted in the <span style="color:cyan">cyan</span> col ## State explanation -For the explanation of what all the different states mean, see the [client documentation](https://github.com/eduvpn/eduvpn-common/blob/v2/client/fsm.go#L14-L50) +For the explanation of what all the different states mean, see the [client documentation](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/client/fsm.go#L14-L50) ## States that ask data diff --git a/docs/src/api/wheretofinddocs.md b/docs/src/api/wheretofinddocs.md index f4ad5bf..cda485f 100644 --- a/docs/src/api/wheretofinddocs.md +++ b/docs/src/api/wheretofinddocs.md @@ -1,6 +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 it is available as autogenerated form [here](./functiondocs.md). +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://github.com/eduvpn/eduvpn-common/tree/v2/client). However, this is not the primary use case for the library. +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. |
