Skip to content

Update API build steps #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReneeVandervelde merged 3 commits into from
Jan 17, 2026
Merged

Update API build steps #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b3cc610
Mute error about build structure.
ReneeVandervelde Jan 17, 2026
f9d9b67
Bring API reference docs up-to-date
ReneeVandervelde Jan 17, 2026
5bd59ee
Update Maven URL
ReneeVandervelde Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
31 changes: 29 additions & 2 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ repositories {
mavenCentral()
}

dependencies {
dokka(project(":auth"))
dokka(project(":core"))
dokka(project(":devices"))
dokka(project(":discover"))
dokka(project(":events"))
dokka(project(":grouped-lights"))
dokka(project(":homekit"))
dokka(project(":internals"))
dokka(project(":lights"))
dokka(project(":resources"))
dokka(project(":rooms"))
dokka(project(":scenes"))
dokka(project(":serialization"))
dokka(project(":structures"))
dokka(project(":zones"))
}

dokka {
moduleName.set("Shade")
}

subprojects {
repositories {
mavenCentral()
Expand All @@ -17,6 +39,11 @@ subprojects {
}
}

tasks.dokkaHtmlMultiModule.configure {
outputDirectory.set(rootDir.resolve("docs/reference/${project.version}"))
tasks.named("dokkaGeneratePublicationHtml") {
doLast {
copy {
from(layout.buildDirectory.dir("dokka/html"))
into(rootDir.resolve("docs/reference/${project.version}"))
}
}
}
10 changes: 6 additions & 4 deletions buildSrc/src/main/kotlin/ink.publishing.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ plugins {
id("org.jetbrains.kotlinx.binary-compatibility-validator")
}

val dokkaHtml by tasks.getting(org.jetbrains.dokka.gradle.DokkaTask::class)
dokka {
moduleName.set(project.name)
}

val javadocJar: TaskProvider<Jar> by tasks.registering(Jar::class) {
dependsOn(dokkaHtml)
dependsOn(tasks.named("dokkaGeneratePublicationHtml"))
archiveClassifier.set("javadoc")
from(dokkaHtml.outputDirectory)
from(layout.buildDirectory.dir("dokka/html"))
}

apiValidation {
Expand All @@ -24,7 +26,7 @@ publishing {
if (mavenUser != null && mavenPassword != null) {
maven {
name = "MavenCentral"
setUrl("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
setUrl("https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/")
credentials {
username = mavenUser
password = mavenPassword
Expand Down
122 changes: 63 additions & 59 deletions docs/reference/latest/auth/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,111 +1,111 @@
<!doctype html>
<html class="no-js">
<html class="no-js" lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>auth</title>
<link href="../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<link href="../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../";</script>
<script>document.documentElement.classList.replace("no-js", "js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
if (savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
<script type="text/javascript" src="../scripts/sourceset_dependencies.js" async></script>
<link href="../styles/style.css" rel="Stylesheet">
<link href="../styles/main.css" rel="Stylesheet">
<link href="../styles/prism.css" rel="Stylesheet">
<link href="../styles/logo-styles.css" rel="Stylesheet">
<link href="../styles/font-jb-sans-auto.css" rel="Stylesheet">
<link href="../ui-kit/ui-kit.min.css" rel="Stylesheet">
<script type="text/javascript" src="../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../scripts/safe-local-storage_blocking.js"></script>
<script type="text/javascript" src="../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../scripts/main.js" defer></script>
<script type="text/javascript" src="../scripts/prism.js" async></script>
<script type="text/javascript" src="../ui-kit/ui-kit.min.js" defer></script>
<script type="text/javascript" src="../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<script type="text/javascript" src="../ui-kit/ui-kit.min.js" defer></script></head>
<body>
<div class="root">
<nav class="navigation theme-dark" id="navigation-wrapper">
<a class="library-name--link" href="../index.html">
shade
<div class="root">
<header class="navigation theme-dark" id="navigation-wrapper" role="banner">
<a class="library-name--link" href="../index.html" tabindex="1">
Shade
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
</button>
<div class="navigation-controls--break ui-kit_mobile-only"></div>
<div class="library-version" id="library-version">latest
</div>
<div class="navigation-controls">
<div class="filter-section filter-section_loading" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":auth:dokkaHtmlPartial/commonMain">common</button>
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">
<button class="platform-tag platform-selector common-like" data-active="" aria-pressed="true" data-filter=":auth/commonMain">common</button>
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox" data-role="dropdown-toggle" aria-controls="platform-tags-listbox" aria-haspopup="listbox" aria-expanded="false" aria-label="Toggle source sets"></button>
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox">
<div class="dropdown--header"><span>Platform filter</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close platform filter">
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox" aria-label="Target filter">
<div class="dropdown--header"><span>Target filter</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close target filter">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
<label class="checkbox">
<input type="checkbox" class="checkbox--input" id=":auth:dokkaHtmlPartial/commonMain" data-filter=":auth:dokkaHtmlPartial/commonMain">
<input type="checkbox" class="checkbox--input" id=":auth/commonMain" data-filter=":auth/commonMain">
<span class="checkbox--icon"></span>
common
</label>
</li>
</ul>
<div class="dropdown--overlay"></div>
</div>
</div>
</ul>
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button" type="button">Switch theme
</button>
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
API
</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list" data-role="dropdown-listbox">
<div class="dropdown--header">
</header>
<div id="container">
<nav id="leftColumn" class="sidebar" data-item-type="SECTION" data-item-config="{&quot;defaultSize&quot;: 280, &quot;minSize&quot;: 200, &quot;maxSize&quot;: 400}">
<a class="toc--skip-link" href="#main">Skip to content</a>
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list" data-role="dropdown-listbox" aria-label="Table of contents">
<div class="dropdown--header">
<span>
shade
Shade
</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<div class="sidebar--inner" id="sideMenu"></div>
</ul>
<div class="dropdown--overlay"></div>
</div>
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<div class="sidebar--inner" id="sideMenu"></div>
</ul>
<div class="dropdown--overlay"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageids="auth::////PointingToDeclaration//-2034723541">
</nav>
<div id="resizer" class="resizer" data-item-type="BAR"></div>
<div id="main" data-item-type="SECTION" role="main">
<div class="main-content" id="content" pageids="auth::////PointingToDeclaration//-637489549">
<div class="breadcrumbs"></div>
<div class="cover ">
<h1 class="cover"><span><span>auth</span></span></h1>
</div>
<h2 class="">Packages</h2>
<div class="table"><a data-name="-1902654672%2FPackages%2F-2034723541" anchor-label="inkapplications.shade.auth" id="-1902654672%2FPackages%2F-2034723541" data-filterable-set=":auth:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":auth:dokkaHtmlPartial/commonMain" data-filterable-set=":auth:dokkaHtmlPartial/commonMain">
<div class="table"><a data-name="-1902654672%2FPackages%2F-637489549" anchor-label="inkapplications.shade.auth" id="-1902654672%2FPackages%2F-637489549" data-filterable-set=":auth/commonMain"></a>
<div class="table-row table-row_platform-tagged" data-filterable-current=":auth/commonMain" data-filterable-set=":auth/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="inkapplications.shade.auth/index.html">inkapplications.shade.auth</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1902654672%2FPackages%2F-2034723541"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1902654672%2FPackages%2F-637489549"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="pull-right platform-tags--wrapper">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
Expand All @@ -114,16 +114,16 @@ <h2 class="">Packages</h2>
<div></div>
</div>
</div>
<a data-name="-1407314846%2FPackages%2F-2034723541" anchor-label="inkapplications.shade.auth.structures" id="-1407314846%2FPackages%2F-2034723541" data-filterable-set=":auth:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":auth:dokkaHtmlPartial/commonMain" data-filterable-set=":auth:dokkaHtmlPartial/commonMain">
<a data-name="-1407314846%2FPackages%2F-637489549" anchor-label="inkapplications.shade.auth.structures" id="-1407314846%2FPackages%2F-637489549" data-filterable-set=":auth/commonMain"></a>
<div class="table-row table-row_platform-tagged" data-filterable-current=":auth/commonMain" data-filterable-set=":auth/commonMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="inkapplications.shade.auth.structures/index.html">inkapplications.shade.auth.structures</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1407314846%2FPackages%2F-2034723541"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1407314846%2FPackages%2F-637489549"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="pull-right platform-tags--wrapper">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">common</div>
</div>
Expand All @@ -135,17 +135,21 @@ <h2 class="">Packages</h2>
</div>
</div>
<div class="footer">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<span>© 2025 Copyright</span>
<span class="pull-right">
<span>Generated by </span>
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
<span>dokka</span>
</a>
</span>
</div>
<div class="footer--container">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<div class="footer--content">
<div>
<span>Generated by </span>
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
Dokka
</a>
<div>© 2026 Copyright</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
</html>
Loading