Skip to content

Commit a58767d

Browse files
chore(deps): Bump org.jetbrains.dokka from 0.10.0 to 1.4.32 (#37)
Bumps [org.jetbrains.dokka](https://github.com/Kotlin/dokka) from 0.10.0 to 1.4.32. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/Kotlin/dokka/releases">org.jetbrains.dokka's releases</a>.</em></p> <blockquote> <h2>1.4.32 Alpha</h2> <p>Fixes:</p> <ul> <li>Fix configuration for suppressing obvious functions (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1789">#1789</a>)</li> <li>Fix visibility on enum entry property (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1828">#1828</a>)</li> <li>Fix missing annotations in GFM and unresolved static imports (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1845">#1845</a>)</li> </ul> <p>Added features:</p> <ul> <li>Reintroduce multimodule documentation (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1804">#1804</a>)</li> <li>Compiler bump to 1.4.32 (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1818">#1818</a>)</li> <li>Suppress inherited members (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1814">#1814</a>)</li> <li>Bump kotlinx.html to 0.7.3 (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1819">#1819</a>) (requires adding &quot;<a href="https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven">https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven</a>&quot; repository)</li> <li>Add ability to document generated files (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1832">#1832</a>)</li> <li>Handle html in KDoc (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1805">#1805</a>)</li> <li>Make anchors stable (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1851">#1851</a>)</li> </ul> <p>Special thanks to external contributors: <a href="https://github.com/AzimMuradov"><code>@​AzimMuradov</code></a> and <a href="https://github.com/hfhbd"><code>@​hfhbd</code></a></p> <h2>1.4.30 Alpha</h2> <p>In this release we focused on improving multi-module experience that would allow links, search and navigation to be rendered for the whole project rather than independent modules. We have also updated the compiler to 1.4.30 and introduced the versioning plugin for the multi module, that lets users generate documentation for each version incrementally and switch between them on the main page.</p> <h2>Breaking changes</h2> <ul> <li>Dokka multi module no longer uses generic <code>dokka${format}</code> task but rather <code>dokka${format}Partial</code> where <code>format</code> is the desired output format like <code>html</code> or <code>gfm</code></li> </ul> <h2>Improvements and bug fixes</h2> <ul> <li>JvmName support <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1675">#1675</a></li> <li>Use Maven directly to download additional dependencies <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1644">#1644</a> thanks <a href="https://github.com/adangel"><code>@​adangel</code></a></li> <li>Fix docs on DProperty <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1671">#1671</a></li> <li>Refactor ContentTable builder and fix GFM table rendering <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1682">#1682</a></li> <li>Versioning <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1654">#1654</a></li> <li>Footer customisation <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1691">#1691</a></li> <li>Resolve Trove issue <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1715">#1715</a></li> <li>Fix incorrect DRI conversion in KotlinAsJava modes for nested definitions <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1701">#1701</a></li> <li>JvmOverloads (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1712">#1712</a>) and add detection of JvmSynthetic (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1718">#1718</a>) thanks <a href="https://github.com/bishiboosh"><code>@​bishiboosh</code></a></li> <li>Annotations for parameters <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1710">#1710</a></li> <li>Fix links to method parameters from documentation <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1713">#1713</a></li> <li>Fix displaying default Java visibility <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1738">#1738</a></li> <li>Add legacy KotlinWebsite format to recognized link formats <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1750">#1750</a></li> <li>Fix parameters in CLI and bump kotlinx.cli <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1755">#1755</a></li> <li>Suppress tag support <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1742">#1742</a></li> <li>Add ability to suppress obvious functions like equals, toString <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1758">#1758</a></li> <li>Make Gradle plugin use <code>api</code> instead of <code>implementation</code> for dokka-core <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1771">#1771</a></li> </ul> <h2>1.4.20 Alpha</h2> <h2>Breaking changes</h2> <ul> <li><code>prefix</code> was replaced by <code>matchingRegex</code> <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/598">#598</a>, thanks <a href="https://github.com/martinbonnin"><code>@​martinbonnin</code></a></li> </ul> <h2>Improvements and bug fixes</h2> <ul> <li>Dokka is now build using Kotlin 1.4.20</li> <li>javadoc now handles <code>@inheritdoc</code> annotation <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1608">#1608</a></li> <li>breadcrumbs improvements in html format <a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1590">#1590</a></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/Kotlin/dokka/commit/8c7ab58f9e2adcf86a7da4697c99dde38db91ac8"><code>8c7ab58</code></a> Update documentation for 1.4.32</li> <li><a href="https://github.com/Kotlin/dokka/commit/db337c6b489d41f7c62bc44f9edb3e5eaa62e0d5"><code>db337c6</code></a> Make anchors stable (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1851">#1851</a>)</li> <li><a href="https://github.com/Kotlin/dokka/commit/7976824f185ac846f687971cca449da2e4c24728"><code>7976824</code></a> Add suggestion about PR-s to issues template</li> <li><a href="https://github.com/Kotlin/dokka/commit/6b3f33f522bd71ce41940f92b13c75bcf556251c"><code>6b3f33f</code></a> Fix suppressing enum entries by inheritance filter (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1866">#1866</a>)</li> <li><a href="https://github.com/Kotlin/dokka/commit/8ef365f60511ac46e8a8bb13562fab4f1de96f6d"><code>8ef365f</code></a> Update documentation with suppressGeneratedFiles and webserver</li> <li><a href="https://github.com/Kotlin/dokka/commit/46b21186e77149f4f41d3b1e8c7d66e7e5e17108"><code>46b2118</code></a> Fix several bugs in configuration examples in gradle user guide (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1831">#1831</a>)</li> <li><a href="https://github.com/Kotlin/dokka/commit/7bfab097f35f86bafbc2feff23e6658ad17da2ae"><code>7bfab09</code></a> Introduce binary compatibility plugin (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1774">#1774</a>)</li> <li><a href="https://github.com/Kotlin/dokka/commit/38270a3b8783857bd0bba4b9422b19b4de507e4c"><code>38270a3</code></a> Fix missing annotations in GFM and unresolved static imports (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1845">#1845</a>)</li> <li><a href="https://github.com/Kotlin/dokka/commit/acd9234be6909a69f89600e9c8ddde642d36b1cf"><code>acd9234</code></a> Fix visibility on enum entry property (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1828">#1828</a>)</li> <li><a href="https://github.com/Kotlin/dokka/commit/357ee8a2836d96204343ff20cab8d17ad2f09aed"><code>357ee8a</code></a> Improve docs for new multimodule (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/1826">#1826</a>)</li> <li>Additional commits viewable in <a href="https://github.com/Kotlin/dokka/compare/0.10.0...v1.4.32">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=org.jetbrains.dokka&package-manager=gradle&previous-version=0.10.0&new-version=1.4.32)](https://dependabot.com/compatibility-score/?dependency-name=org.jetbrains.dokka&package-manager=gradle&previous-version=0.10.0&new-version=1.4.32) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in the `.dependabot/config.yml` file in this repo: - Update frequency - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired) </details>
1 parent 63bf927 commit a58767d

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

.github/workflows/ci.yml

+10-6
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
3232
- uses: eskatos/gradle-command-action@v1
3333
with:
34-
arguments: build
34+
arguments: build dokkaHtml
3535

3636
release:
3737
needs: ci
@@ -56,15 +56,19 @@ jobs:
5656
- name: Generate docs
5757
uses: eskatos/gradle-command-action@v1
5858
with:
59-
arguments: dokka
59+
arguments: dokkaHtml
6060

6161
# Ridiculous workaround for https://github.com/Kotlin/dokka/issues/163
62-
- name: Move Dokka's stylesheet into a sensible place
62+
- name: Move Dokka's assets into a sensible place
6363
run: |
6464
set -x -o nounset -o errexit -o pipefail
65-
cd ./build/javadoc
66-
mv ./style.css ./awala-testing/
67-
find . -name '*.html' -print0 | xargs -0 sed -i 's;../style.css;style.css;g'
65+
cd ./build/dokka/html
66+
mv ./styles ./images ./scripts navigation.html index.html ./awala-testing/
67+
find ./awala-testing/ -name '*.html' -print0 | xargs -0 sed -i 's;../styles/;styles/;g'
68+
find ./awala-testing/ -name '*.html' -print0 | xargs -0 sed -i 's;../images/;images/;g'
69+
find ./awala-testing/ -name '*.html' -print0 | xargs -0 sed -i 's;../scripts/;scripts/;g'
70+
find ./awala-testing/ -name '*.html' -print0 | xargs -0 sed -i 's;pathToRoot = "../;pathToRoot = ";g'
71+
sed -i 's;href="awala-testing/;href=";g' ./awala-testing/navigation.html
6872
6973
- name: Setup Node.js
7074
uses: actions/setup-node@v1

build.gradle

+7-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ buildscript{
1111
plugins {
1212
id("org.jetbrains.kotlin.jvm") version "$kotlinVersion"
1313
id('java-library')
14-
id("org.jetbrains.dokka") version "0.10.0"
14+
id("org.jetbrains.dokka") version "1.4.32"
1515
id("com.diffplug.spotless") version "5.14.0"
1616
id('idea')
1717

@@ -66,9 +66,12 @@ test {
6666

6767
// Documentation
6868

69-
tasks.dokka {
70-
outputFormat = "html"
71-
outputDirectory = "$buildDir/javadoc"
69+
dokkaHtml.configure {
70+
dokkaSourceSets {
71+
configureEach {
72+
reportUndocumented.set(true)
73+
}
74+
}
7275
}
7376

7477
// Publishing

0 commit comments

Comments
 (0)