Skip to content

Commit 75e832c

Browse files
cybercoder-najcybercoder-naj
authored
Merge pull request #3 from cybercoder-naj/feat/configure-docs
feat: Configure Dokka and Actions to deploy to Pages
2 parents 6e3be3f + 4b728c8 commit 75e832c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+3414
-4
lines changed

‎.github/workflows/build-test.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ jobs:
1717
- name: Setup Gradle
1818
uses: gradle/actions/setup-gradle@v3
1919
- name: Build code
20-
run: ./gradlew build
20+
run: ./gradlew :build
2121
- name: Test code
22-
run: ./gradlew test
22+
run: ./gradlew :test

‎.github/workflows/deploy-docs.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
workflow_run:
5+
workflows: ["Build and Test"]
6+
branches: [main]
7+
types:
8+
- completed
9+
10+
jobs:
11+
generate-docs:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Gradle
19+
uses: gradle/actions/setup-gradle@v3
20+
21+
- name: Generate docs
22+
run: ./gradlew :dokkaHtml
23+
24+
- name: Bundle Docs
25+
uses: actions/upload-pages-artifact@v1
26+
with:
27+
path: "./docs"
28+
29+
deploy-docs:
30+
needs: generate-docs
31+
32+
permissions:
33+
pages: write
34+
id-token: write
35+
36+
environment:
37+
name: github-pages
38+
url: ${{ steps.deployment.outputs.page_url }}
39+
40+
runs-on: ubuntu-latest
41+
steps:
42+
- name: Deploy docs
43+
id: deployment
44+
uses: actions/deploy-pages@v3

‎.idea/kotlinc.xml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎build.gradle.kts‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1+
import org.jetbrains.dokka.gradle.DokkaTask
2+
import java.net.URI
3+
14
plugins {
2-
kotlin("jvm") version "1.9.23"
5+
kotlin("jvm") version "2.0.0"
36
alias(libs.plugins.dokka)
47
`java-library`
58
}
69

710
group = "io.github.cybercodernaj"
811
version = libs.versions.lib.get()
912

13+
val docsDir = layout.projectDirectory.dir("docs/")
14+
1015
repositories {
1116
mavenCentral()
1217
}
@@ -21,3 +26,20 @@ tasks.test {
2126
kotlin {
2227
jvmToolchain(18)
2328
}
29+
30+
tasks.withType<DokkaTask>().configureEach {
31+
moduleName.set(project.name)
32+
moduleVersion.set(project.version.toString())
33+
outputDirectory.set(docsDir)
34+
dokkaSourceSets.configureEach {
35+
sourceLink {
36+
localDirectory.set(projectDir.resolve("src"))
37+
remoteUrl.set(URI.create("https://github.com/cybercoder-naj/Parkour/blob/main/src").toURL())
38+
remoteLineSuffix.set("#L")
39+
}
40+
}
41+
}
42+
43+
tasks.clean {
44+
delete = setOf(docsDir, layout.buildDirectory)
45+
}

‎docs/-parkour/io.github.cybercodernaj.parkour/-parser/-parser.html‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>Parser</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../../index.html">
44+
Parkour
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
0.0.1 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="member" id="content" pageIds="Parkour::io.github.cybercodernaj.parkour/Parser/Parser/#/PointingToDeclaration//769193423">
65+
<div class="breadcrumbs"><a href="../../../index.html">Parkour</a><span class="delimiter">/</span><a href="../index.html">io.github.cybercodernaj.parkour</a><span class="delimiter">/</span><a href="index.html">Parser</a><span class="delimiter">/</span><span class="current">Parser</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span><span>Parser</span></span></h1>
68+
</div>
69+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/Parkour/blob/main/src/main/kotlin/io/github/cybercodernaj/parkour/Parser.kt#L9">source</a>)</span></span></div></div></div>
70+
</div>
71+
<div class="footer">
72+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
73+
class="pull-right"><span>Generated by </span><a
74+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
75+
</div>
76+
</div>
77+
</div>
78+
</div>
79+
</body>
80+
</html>

‎docs/-parkour/io.github.cybercodernaj.parkour/-parser/index.html‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>Parser</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../../index.html">
44+
Parkour
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
0.0.1 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="classlike" id="content" pageIds="Parkour::io.github.cybercodernaj.parkour/Parser///PointingToDeclaration//769193423">
65+
<div class="breadcrumbs"><a href="../../../index.html">Parkour</a><span class="delimiter">/</span><a href="../index.html">io.github.cybercodernaj.parkour</a><span class="delimiter">/</span><span class="current">Parser</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span><span>Parser</span></span></h1>
68+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">Parser</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/Parkour/blob/main/src/main/kotlin/io/github/cybercodernaj/parkour/Parser.kt#L9">source</a>)</span></span></div><p class="paragraph">A parser class.</p><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">Nishant Aanjaney Jalan</p></span><span class="kdoc-tag"><h4 class="">Since</h4><p class="paragraph">0.0.1</p></span></div></div>
69+
</div>
70+
<div class="tabbedcontent">
71+
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
72+
<div class="tabs-section-body">
73+
<div data-togglable="CONSTRUCTOR">
74+
<h2 class="">Constructors</h2>
75+
<div class="table"><a data-name="-1042165343%2FConstructors%2F769193423" anchor-label="Parser" id="-1042165343%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
76+
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
77+
<div class="main-subrow keyValue ">
78+
<div class=""><span class="inline-flex">
79+
<div><a href="-parser.html"><span><span>Parser</span></span></a></div>
80+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1042165343%2FConstructors%2F769193423"></span>
81+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
82+
</span></span></div>
83+
<div>
84+
<div class="title">
85+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
</div>
91+
</div>
92+
<div data-togglable="FUNCTION">
93+
<h2 class="">Functions</h2>
94+
<div class="table"><a data-name="385634132%2FFunctions%2F769193423" anchor-label="someFunction" id="385634132%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
95+
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
96+
<div class="main-subrow keyValue ">
97+
<div class=""><span class="inline-flex">
98+
<div><a href="some-function.html"><span>some</span><wbr></wbr><span><span>Function</span></span></a></div>
99+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="385634132%2FFunctions%2F769193423"></span>
100+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
101+
</span></span></div>
102+
<div>
103+
<div class="title">
104+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="some-function.html"><span class="token function">someFunction</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
105+
</div>
106+
</div>
107+
</div>
108+
</div>
109+
</div>
110+
</div>
111+
</div>
112+
</div>
113+
</div>
114+
<div class="footer">
115+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
116+
class="pull-right"><span>Generated by </span><a
117+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
118+
</div>
119+
</div>
120+
</div>
121+
</div>
122+
</body>
123+
</html>

0 commit comments

Comments
 (0)