forked from arrow-kt/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc-conf.gradle
38 lines (35 loc) · 1.48 KB
/
doc-conf.gradle
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/*
* Copyright (C) 2020 The Arrow Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
//dokka log spam `Can't find node by signature` comes from https://github.com/Kotlin/dokka/issues/269
dokka {
outputFormat = 'jekyll'
outputDirectory = "${rootDir}/arrow-docs/docs/apidocs"
configuration {
includes = ['README.md']
reportUndocumented = false
// Specifies the location of the project source code on the Web.
// If provided, Dokka generates "source" links for each declaration.
// Repeat for multiple mappings
sourceLink {
// Source directory
path = "src/main/kotlin"
// URL showing where the source code can be accessed through the web browser
url = "https://github.com/arrow-kt/arrow/blob/master/${relativeProjectPath('src/main/kotlin')}"
// Suffix which is used to append the line number to the URL. Use #L for GitHub
lineSuffix = "#L"
}
}
}