Skip to content

Commit 89419b6

Browse files
committed
generate docs correctly
Signed-off-by: Adam Ratzman <[email protected]>
1 parent 76ef43c commit 89419b6

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ packagingOptions {
6969
```
7070

7171
## Documentation
72-
The `spotify-web-api-kotlin` JavaDocs are hosted at https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/
72+
The `spotify-web-api-kotlin` JavaDocs are hosted [here](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/).
7373

7474
## Have a question?
7575
If you have a question, you can:
@@ -97,7 +97,7 @@ By default, the SpotifyApi `Token` automatically regenerates when needed.
9797
This can be changed by overriding the `automaticRefresh` builder setting.
9898

9999
There are four exposed builders, depending on the level of control you need over api creation.
100-
Please see the [spotifyAppApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-app-api.html) for a full list of available builders.
100+
Please see the [spotifyAppApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-app-api.html) for a full list of available builders.
101101

102102
You will need:
103103
- Spotify application client id
@@ -165,7 +165,7 @@ This library contains helpful methods that can be used to simplify the PKCE auth
165165
This includes `getSpotifyPkceCodeChallenge` (not available in the Kotlin/JS target), which SHA256 hashes and base64url encodes the code
166166
challenge, and `getPkceAuthorizationUrl`, which allows you to generate an easy authorization url for PKCE flow.
167167

168-
Please see the [spotifyClientPkceApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-pkce-api.html) for a full list of available builders.
168+
Please see the [spotifyClientPkceApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-pkce-api.html) for a full list of available builders.
169169

170170
**Takeaway**: Use PKCE authorization flow in applications where you cannot secure the client secret.
171171

@@ -224,7 +224,7 @@ There are also several optional parameters, allowing you to set whether the auth
224224
for implicit grant flow, the state, and whether a re-authorization dialog should be shown to users.
225225

226226
There are several exposed builders, depending on the level of control you need over api creation.
227-
Please see the [spotifyClientApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-api.html) for a full list of available builders.
227+
Please see the [spotifyClientApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-api.html) for a full list of available builders.
228228

229229
##### Example: You've redirected the user back to your web server and have an authorization code (code).
230230
In this example, automatic token refresh is turned on by default.
@@ -275,7 +275,7 @@ Some highlights about the flow are:
275275
- It is client-side
276276
- It does not require a client secret
277277

278-
Please see the [spotifyImplicitGrantApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-implicit-grant-api.html) for a full list of available builders.
278+
Please see the [spotifyImplicitGrantApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-implicit-grant-api.html) for a full list of available builders.
279279

280280
The Kotlin/JS target contains the `parseSpotifyCallbackHashToToken` method, which will parse the hash
281281
for the current url into a Token object, with which you can then instantiate the api.

build.gradle.kts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@ buildscript {
3131
}
3232
}
3333

34-
dependencies {
35-
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.20")
36-
}
37-
3834
group = "com.adamratzman"
3935
version = "3.3.01"
4036

@@ -277,6 +273,18 @@ signing {
277273
tasks {
278274
val dokkaHtml by getting(DokkaTask::class) {
279275
outputDirectory.set(projectDir.resolve("docs"))
276+
277+
dokkaSourceSets {
278+
configureEach {
279+
skipDeprecated.set(true)
280+
281+
sourceLink {
282+
localDirectory.set(file("src"))
283+
remoteUrl.set(uri("https://github.com/adamint/spotify-web-api-kotlin/tree/master/src").toURL())
284+
remoteLineSuffix.set("#L")
285+
}
286+
}
287+
}
280288
}
281289

282290
spotless {

0 commit comments

Comments
 (0)