Skip to content

Commit

Permalink
Customize generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
paulinea committed Jan 2, 2025
1 parent d9bcd22 commit c200994
Show file tree
Hide file tree
Showing 1,429 changed files with 201,914 additions and 11 deletions.
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ dokka {

dokkaPublications.html {
includes.from("docs/index.md")
outputDirectory.set(layout.buildDirectory.dir("docs/dokka"))
outputDirectory.set(projectDir.resolve("docs/dokka"))
}
}
2 changes: 2 additions & 0 deletions buildSrc/src/main/kotlin/dokka.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ dokka {
configureEach {
includes.from("Module.md")
pluginsConfiguration.html {
customAssets.from("${rootProject.projectDir}/docs/assets/logo-icon.svg")
customStyleSheets.from("${rootProject.projectDir}/docs/assets/orange-style.css")
footerMessage.set("Copyright © Orange 2024")
}
}
}
Expand Down
20 changes: 10 additions & 10 deletions docs/assets/orange-style.css
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
/* --- root styles --- */
:root {
--color-key-blue: #ff7900;

--footer-font-color: black;
--footer-go-to-top-color: white;

--active-section-color: #ff7900;
--active-tab-border-color: #ff7900;
--sidemenu-section-active-color: #ff7900;

--default-font-family: Helvetica Neue, Roboto, Arial, sans-serif;
}

.library-name--link {
font-size: 28px;
font-weight: 700;

/* Remove "ANDROIDJVM" button in header */
.filter-section {
display: none;
}

.sideMenuPart[data-active] > .overview > a {
.toc--part[data-active]>.toc--row .toc--button, .toc--part[data-active]>.toc--row .toc--link {
font-weight: 700;
}

.sidebar--inner {
font-size: 13px;
.library-name--link {
font-size: 28px;
font-weight: 700;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Hierarchy</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>
<script>const storage = localStorage.getItem("dokka-dark-mode")
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")
}
} else {
const savedDarkMode = JSON.parse(storage)
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/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>
<link href="../../../images/logo-icon.svg">
<link href="../../../styles/orange-style.css" rel="Stylesheet"></head>
<body>
<div class="root">
<nav class="navigation theme-dark" id="navigation-wrapper">
<a class="library-name--link" href="../../../index.html">
OUDS Android
</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">0.1.0
</div>
<div class="navigation-controls">
<div class="filter-section filter-section_loading" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":core/release">androidJvm</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">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<li role="option" class="dropdown--option platform-selector-option jvm-like" tabindex="0">
<label class="checkbox">
<input type="checkbox" class="checkbox--input" id=":core/release" data-filter=":core/release">
<span class="checkbox--icon"></span>
androidJvm
</label>
</li>
</ul>
<div class="dropdown--overlay"></div>
</div>
</div>
<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">
<span>
OUDS Android
</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>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="core::com.orange.ouds.core.component.button/OudsButtonDefaults/Hierarchy/#/PointingToDeclaration//-1261813462">
<div class="breadcrumbs"><a href="../../index.html">core</a><span class="delimiter">/</span><a href="../index.html">com.orange.ouds.core.component.button</a><span class="delimiter">/</span><a href="index.html">OudsButtonDefaults</a><span class="delimiter">/</span><span class="current">Hierarchy</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Hierarchy</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="-hierarchy.html">Hierarchy</a><span class="token operator">: </span><a href="../-ouds-button/-hierarchy/index.html">OudsButton.Hierarchy</a></div><p class="paragraph">The default hierarchy.</p></div></div>
</div>
<div class="footer">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<span>Copyright © Orange 2024</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>
</div>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Style</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>
<script>const storage = localStorage.getItem("dokka-dark-mode")
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")
}
} else {
const savedDarkMode = JSON.parse(storage)
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/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>
<link href="../../../images/logo-icon.svg">
<link href="../../../styles/orange-style.css" rel="Stylesheet"></head>
<body>
<div class="root">
<nav class="navigation theme-dark" id="navigation-wrapper">
<a class="library-name--link" href="../../../index.html">
OUDS Android
</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">0.1.0
</div>
<div class="navigation-controls">
<div class="filter-section filter-section_loading" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":core/release">androidJvm</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">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<li role="option" class="dropdown--option platform-selector-option jvm-like" tabindex="0">
<label class="checkbox">
<input type="checkbox" class="checkbox--input" id=":core/release" data-filter=":core/release">
<span class="checkbox--icon"></span>
androidJvm
</label>
</li>
</ul>
<div class="dropdown--overlay"></div>
</div>
</div>
<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">
<span>
OUDS Android
</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>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="core::com.orange.ouds.core.component.button/OudsButtonDefaults/Style/#/PointingToDeclaration//-1261813462">
<div class="breadcrumbs"><a href="../../index.html">core</a><span class="delimiter">/</span><a href="../index.html">com.orange.ouds.core.component.button</a><span class="delimiter">/</span><a href="index.html">OudsButtonDefaults</a><span class="delimiter">/</span><span class="current">Style</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Style</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="-style.html">Style</a><span class="token operator">: </span><a href="../-ouds-button/-style/-default/index.html">OudsButton.Style.Default</a></div><p class="paragraph">The default style.</p></div></div>
</div>
<div class="footer">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<span>Copyright © Orange 2024</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>
</div>
</div>
</body>
</html>
Loading

0 comments on commit c200994

Please sign in to comment.