Skip to content

Commit 8d81d45

Browse files
levinzonrlevinzonr
committed
docs: Use README as Main page in hosted doccumentation and include Changelog
1 parent f55b300 commit 8d81d45

Some content is hidden

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

63 files changed

+10210
-21
lines changed

‎.github/workflows/docs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ jobs:
2929
restore-keys: |
3030
mkdocs-material-
3131
- run: |
32-
./gradlew dokkaHtmlMultiModule
33-
mv build/dokka/htmlMultiModule docs/api
32+
chmod +x ./generate_docs.sh
33+
./generate_docs.sh
34+
3435
- run: pip install mkdocs-material
3536
- run: mkdocs gh-deploy --force

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This is a template for creating Android Open Source libraries. This template features
44

5-
- :rocket: Basis Project structure that includes demo and library modules
6-
- :octocat: CI/CD with GitHub Actions for release and snapshot builds, documentation generation
7-
- :mag: Code Quality checks with Detekt, Spotless and Tests
8-
- :book: Documentation setup with Dokka and MkDocs
9-
- :package: Dependency management with Version Catalogue
10-
- :memo: CHANGELOG following a keepchangelog.com format
11-
- :wrench: Gradle Convention Plugins for consistent build configuration across modules
5+
- 🏗️Basis Project structure that includes demo and library modules
6+
- 🚀 CI/CD with GitHub Actions for release and snapshot builds, documentation generation
7+
- 🔍 Code Quality checks with Detekt, Spotless and Tests
8+
- 📕 Documentation setup with Dokka and MkDocs
9+
- 📦 Dependency management with Version Catalogue
10+
- 📝 CHANGELOG following a keepchangelog.com format
11+
- 🔧 Gradle Convention Plugins for consistent build configuration across modules
1212
- 🌐 GH pages to host the documentation
1313

1414
## Table of Contents

‎docs/api/demo/index.html

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
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>demo</title>
6+
<link href="../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../";</script>
7+
<script>document.documentElement.classList.replace("no-js","js");</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
if (storage == null) {
10+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
11+
if (osDarkSchemePreferred === true) {
12+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
13+
}
14+
} else {
15+
const savedDarkMode = JSON.parse(storage)
16+
if(savedDarkMode === true) {
17+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
18+
}
19+
}
20+
</script>
21+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
22+
<script type="text/javascript" src="../scripts/sourceset_dependencies.js" async></script>
23+
<link href="../styles/style.css" rel="Stylesheet">
24+
<link href="../styles/main.css" rel="Stylesheet">
25+
<link href="../styles/prism.css" rel="Stylesheet">
26+
<link href="../styles/logo-styles.css" rel="Stylesheet">
27+
<link href="../styles/font-jb-sans-auto.css" rel="Stylesheet">
28+
<script type="text/javascript" src="../scripts/clipboard.js" async></script>
29+
<script type="text/javascript" src="../scripts/navigation-loader.js" async></script>
30+
<script type="text/javascript" src="../scripts/platform-content-handler.js" async></script>
31+
<script type="text/javascript" src="../scripts/main.js" defer></script>
32+
<script type="text/javascript" src="../scripts/prism.js" async></script>
33+
<script type="text/javascript" src="../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
34+
<body>
35+
<div class="root">
36+
<nav class="navigation" id="navigation-wrapper">
37+
<div class="navigation--inner">
38+
<div class="navigation-title">
39+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
40+
<div class="library-name">
41+
<a class="library-name--link" href="../index.html">
42+
android-lib-template
43+
</a> </div>
44+
<div class="library-version">
45+
</div>
46+
</div>
47+
<div class="filter-section" id="filter-section">
48+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":demo:dokkaHtmlPartial/release">androidJvm</button>
49+
</div>
50+
</div>
51+
<div class="navigation-controls">
52+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
53+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
54+
</div>
55+
</nav>
56+
<div id="container">
57+
<div class="sidebar" id="leftColumn">
58+
<div class="sidebar--inner" id="sideMenu"></div>
59+
</div>
60+
<div id="main">
61+
<div class="main-content" id="content" pageids="demo::////PointingToDeclaration//-1084635248">
62+
<div class="breadcrumbs"></div>
63+
<div class="cover ">
64+
<h1 class="cover"><span><span>demo</span></span></h1>
65+
</div>
66+
<h2 class="">Packages</h2>
67+
<div class="table"><a data-name="69227164%2FPackages%2F-1084635248" anchor-label="io.monstarlab.demo" id="69227164%2FPackages%2F-1084635248" data-filterable-set=":demo:dokkaHtmlPartial/release"></a>
68+
<div class="table-row" data-filterable-current=":demo:dokkaHtmlPartial/release" data-filterable-set=":demo:dokkaHtmlPartial/release">
69+
<div>
70+
<div class="main-subrow ">
71+
<div class=""><span class="inline-flex">
72+
<div><a href="io.monstarlab.demo/index.html">io.monstarlab.demo</a></div>
73+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="69227164%2FPackages%2F-1084635248"></span>
74+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
75+
</span></span></div>
76+
<div class="pull-right">
77+
<div class="platform-tags no-gutters">
78+
<div class="platform-tag jvm-like">androidJvm</div>
79+
</div>
80+
</div>
81+
</div>
82+
<div></div>
83+
</div>
84+
</div>
85+
<a data-name="-1724040635%2FPackages%2F-1084635248" anchor-label="io.monstarlab.demo.ui.theme" id="-1724040635%2FPackages%2F-1084635248" data-filterable-set=":demo:dokkaHtmlPartial/release"></a>
86+
<div class="table-row" data-filterable-current=":demo:dokkaHtmlPartial/release" data-filterable-set=":demo:dokkaHtmlPartial/release">
87+
<div>
88+
<div class="main-subrow ">
89+
<div class=""><span class="inline-flex">
90+
<div><a href="io.monstarlab.demo.ui.theme/index.html">io.monstarlab.demo.ui.theme</a></div>
91+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1724040635%2FPackages%2F-1084635248"></span>
92+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
93+
</span></span></div>
94+
<div class="pull-right">
95+
<div class="platform-tags no-gutters">
96+
<div class="platform-tag jvm-like">androidJvm</div>
97+
</div>
98+
</div>
99+
</div>
100+
<div></div>
101+
</div>
102+
</div>
103+
</div>
104+
</div>
105+
<div class="footer">
106+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
107+
</div>
108+
</div>
109+
</div>
110+
</div>
111+
</body>
112+
</html>
113+

‎docs/api/demo/io.monstarlab.demo.ui.theme/-app-theme.html

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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>AppTheme</title>
6+
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../";</script>
7+
<script>document.documentElement.classList.replace("no-js","js");</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
if (storage == null) {
10+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
11+
if (osDarkSchemePreferred === true) {
12+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
13+
}
14+
} else {
15+
const savedDarkMode = JSON.parse(storage)
16+
if(savedDarkMode === true) {
17+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
18+
}
19+
}
20+
</script>
21+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
22+
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
23+
<link href="../../styles/style.css" rel="Stylesheet">
24+
<link href="../../styles/main.css" rel="Stylesheet">
25+
<link href="../../styles/prism.css" rel="Stylesheet">
26+
<link href="../../styles/logo-styles.css" rel="Stylesheet">
27+
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
28+
<script type="text/javascript" src="../../scripts/clipboard.js" async></script>
29+
<script type="text/javascript" src="../../scripts/navigation-loader.js" async></script>
30+
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
31+
<script type="text/javascript" src="../../scripts/main.js" defer></script>
32+
<script type="text/javascript" src="../../scripts/prism.js" async></script>
33+
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
34+
<body>
35+
<div class="root">
36+
<nav class="navigation" id="navigation-wrapper">
37+
<div class="navigation--inner">
38+
<div class="navigation-title">
39+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
40+
<div class="library-name">
41+
<a class="library-name--link" href="../../index.html">
42+
android-lib-template
43+
</a> </div>
44+
<div class="library-version">
45+
</div>
46+
</div>
47+
<div class="filter-section" id="filter-section">
48+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":demo:dokkaHtmlPartial/release">androidJvm</button>
49+
</div>
50+
</div>
51+
<div class="navigation-controls">
52+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
53+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
54+
</div>
55+
</nav>
56+
<div id="container">
57+
<div class="sidebar" id="leftColumn">
58+
<div class="sidebar--inner" id="sideMenu"></div>
59+
</div>
60+
<div id="main">
61+
<div class="main-content" data-page-type="member" id="content" pageids="demo::io.monstarlab.demo.ui.theme//AppTheme/#kotlin.Boolean#kotlin.Boolean#kotlin.Function0[kotlin.Unit]/PointingToDeclaration//-1084635248">
62+
<div class="breadcrumbs"><a href="../index.html">demo</a><span class="delimiter">/</span><a href="index.html">io.monstarlab.demo.ui.theme</a><span class="delimiter">/</span><span class="current">AppTheme</span></div>
63+
<div class="cover ">
64+
<h1 class="cover"><span>App</span><wbr><span><span>Theme</span></span></h1>
65+
</div>
66+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":demo:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="-app-theme.html"><span class="token function">AppTheme</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">darkTheme<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span>isSystemInDarkTheme()<span class="token punctuation">, </span></span><span class="parameter ">dynamicColor<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">content<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a>&nbsp;</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div></div></div>
67+
</div>
68+
<div class="footer">
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
70+
</div>
71+
</div>
72+
</div>
73+
</div>
74+
</body>
75+
</html>
76+

‎docs/api/demo/io.monstarlab.demo.ui.theme/-pink40.html

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

0 commit comments

Comments
 (0)