chore: move docs to root directory

Orange-OpenSource · Dec 17, 2024 · 07d7e0b · 07d7e0b
1 parent 46dc751
commit 07d7e0b
Show file tree

Hide file tree

Showing 22 changed files with 8,218 additions and 0 deletions.
diff --git a/docs/__404error.html b/docs/__404error.html
@@ -0,0 +1,93 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="description" content="ouds_flutter API docs, for the Dart programming language.">
+  <title>ouds_flutter - Dart API docs</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
+
+  <link rel="stylesheet" href="static-assets/github.css?v1">
+  <link rel="stylesheet" href="static-assets/styles.css?v1">
+  <link rel="icon" href="static-assets/favicon.png?v1">
+
+</head>
+
+<body data-base-href="" data-using-base-href="false" class="light-theme">
+<div id="overlay-under-drawer"></div>
+<header id="title">
+  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li class="self-crumb">ouds_flutter package</li>
+  </ol>
+  <div class="self-name">ouds_flutter</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+  <div class="toggle" id="theme-button" title="Toggle brightness">
+    <label for="theme">
+      <input type="checkbox" id="theme" value="light-theme">
+      <span id="dark-theme-button" class="material-symbols-outlined">
+        dark_mode
+      </span>
+      <span id="light-theme-button" class="material-symbols-outlined">
+        light_mode
+      </span>
+    </label>
+  </div>
+</header>
+<main>
+  <div id="dartdoc-main-content" class="main-content">
+    <h1>404: Something's gone wrong :-(</h1>
+    <section class="desc">
+      <p>You've tried to visit a page that doesn't exist.  Luckily this site
+         has other <a href="index.html">pages</a>.</p>
+      <p>If you were looking for something specific, try searching:
+      <form class="search-body" role="search">
+        <input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+      </form>
+      </p>
+    </section>
+  </div> <!-- /.main-content -->
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
+<header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+    <li class="self-crumb">ouds_flutter package</li>
+</ol>
+
+    <h5><span class="package-name">ouds_flutter</span> <span class="package-kind">package</span></h5>
+    <ol>
+      <li class="section-title">Libraries</li>
+      <li><a href="core_ouds_theme/core_ouds_theme-library.html">core/ouds_theme</a></li>
+</ol>
+
+  </div>
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div>
+</main>
+<footer>
+  <span class="no-break">
+    ouds_flutter
+      0.0.1
+  </span>
+
+</footer>
+
+
+<script src="static-assets/highlight.pack.js?v1"></script>
+<script src="static-assets/docs.dart.js"></script>
+
+</body>
+</html>
+
diff --git a/docs/categories.json b/docs/categories.json
@@ -0,0 +1 @@
+[]
diff --git a/docs/core_ouds_theme/OudsTheme-class-sidebar.html b/docs/core_ouds_theme/OudsTheme-class-sidebar.html
@@ -0,0 +1,29 @@
+<ol>
+
+
+
+
+        <li class="section-title inherited">
+          <a href="core_ouds_theme/OudsTheme-class.html#instance-properties">Properties</a>
+        </li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
+
+        <li class="section-title inherited"><a href="core_ouds_theme/OudsTheme-class.html#instance-methods">Methods</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
+
+        <li class="section-title inherited"><a href="core_ouds_theme/OudsTheme-class.html#operators">Operators</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
+
+
+
+
+      <li class="section-title"><a href="core_ouds_theme/OudsTheme-class.html#static-properties">Static properties</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/inverseThemeDark.html">inverseThemeDark</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/inverseThemeLight.html">inverseThemeLight</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/orangeThemeDark.html">orangeThemeDark</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/orangeThemeLight.html">orangeThemeLight</a></li>
+
+
+</ol>
diff --git a/docs/core_ouds_theme/OudsTheme-class.html b/docs/core_ouds_theme/OudsTheme-class.html
@@ -0,0 +1,253 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="description" content="API docs for the OudsTheme class from the ouds_theme library, for the Dart programming language.">
+  <title>OudsTheme class - ouds_theme library - Dart API</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
+
+  <link rel="stylesheet" href="../static-assets/github.css?v1">
+  <link rel="stylesheet" href="../static-assets/styles.css?v1">
+  <link rel="icon" href="../static-assets/favicon.png?v1">
+
+</head>
+
+<body data-base-href="../" data-using-base-href="false" class="light-theme">
+<div id="overlay-under-drawer"></div>
+<header id="title">
+  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li><a href="../index.html">ouds_flutter</a></li>
+    <li><a href="../core_ouds_theme/core_ouds_theme-library.html">core&#47;ouds_theme.dart</a></li>
+    <li class="self-crumb">OudsTheme class</li>
+  </ol>
+  <div class="self-name">OudsTheme</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+  <div class="toggle" id="theme-button" title="Toggle brightness">
+    <label for="theme">
+      <input type="checkbox" id="theme" value="light-theme">
+      <span id="dark-theme-button" class="material-symbols-outlined">
+        dark_mode
+      </span>
+      <span id="light-theme-button" class="material-symbols-outlined">
+        light_mode
+      </span>
+    </label>
+  </div>
+</header>
+<main>
+<div
+    id="dartdoc-main-content"
+    class="main-content"
+    data-above-sidebar="core_ouds_theme&#47;core_ouds_theme-library-sidebar.html"
+    data-below-sidebar="core_ouds_theme&#47;OudsTheme-class-sidebar.html">
+    <div>
+<h1><span class="kind-class">OudsTheme</span> class 
+
+</h1></div>
+
+
+<section class="desc markdown">
+  <p>A class to define and manage the different themes for the OUDS application.
+This class provides light and dark themes as well as inverse themes for various UI components.</p>
+</section>
+
+
+
+
+
+  <section
+      class="summary offset-anchor inherited"
+      id="instance-properties">
+    <h2>Properties</h2>
+    <dl class="properties">
+        <dt id="hashCode" class="property inherited">
+  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
+  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
+
+
+</dt>
+<dd class="inherited">
+  The hash code for this object.
+  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
+
+</dd>
+
+        <dt id="runtimeType" class="property inherited">
+  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
+  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
+
+
+</dt>
+<dd class="inherited">
+  A representation of the runtime type of the object.
+  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
+
+</dd>
+
+    </dl>
+  </section>
+
+  <section
+      class="summary offset-anchor inherited"
+      id="instance-methods">
+    <h2>Methods</h2>
+    <dl class="callables">
+        <dt id="noSuchMethod" class="callable inherited">
+  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
+    <span class="returntype parameter">&#8594; dynamic</span>
+  </span>
+
+
+</dt>
+<dd class="inherited">
+  Invoked when a nonexistent method or property is accessed.
+  <div class="features"><span class="feature">inherited</span></div>
+
+</dd>
+
+        <dt id="toString" class="callable inherited">
+  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
+    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
+  </span>
+
+
+</dt>
+<dd class="inherited">
+  A string representation of this object.
+  <div class="features"><span class="feature">inherited</span></div>
+
+</dd>
+
+    </dl>
+  </section>
+
+  <section
+      class="summary offset-anchor inherited"
+      id="operators">
+    <h2>Operators</h2>
+    <dl class="callables">
+        <dt id="operator ==" class="callable inherited">
+  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
+    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
+  </span>
+
+
+</dt>
+<dd class="inherited">
+  The equality operator.
+  <div class="features"><span class="feature">inherited</span></div>
+
+</dd>
+
+    </dl>
+  </section>
+
+  <section class="summary offset-anchor" id="static-properties">
+    <h2>Static Properties</h2>
+    <dl class="properties">
+        <dt id="inverseThemeDark" class="property">
+  <span class="name"><a href="../core_ouds_theme/OudsTheme/inverseThemeDark.html">inverseThemeDark</a></span>
+  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/material/ThemeData-class.html">ThemeData</a></span>
+
+
+</dt>
+<dd>
+  Inverse Theme (Dark)
+This theme defines the color scheme, app bar, navigation bar, and other UI elements for the dark theme using the orange color palette.
+It is primarily used in dark mode interfaces.
+  <div class="features"><span class="feature">getter/setter pair</span></div>
+
+</dd>
+
+        <dt id="inverseThemeLight" class="property">
+  <span class="name"><a href="../core_ouds_theme/OudsTheme/inverseThemeLight.html">inverseThemeLight</a></span>
+  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/material/ThemeData-class.html">ThemeData</a></span>
+
+
+</dt>
+<dd>
+  Inverse Theme (Light)
+This theme defines the color scheme, app bar, navigation bar, and other UI elements for the light theme using the orange color palette.
+It is primarily used in light mode interfaces.
+  <div class="features"><span class="feature">getter/setter pair</span></div>
+
+</dd>
+
+        <dt id="orangeThemeDark" class="property">
+  <span class="name"><a href="../core_ouds_theme/OudsTheme/orangeThemeDark.html">orangeThemeDark</a></span>
+  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/material/ThemeData-class.html">ThemeData</a></span>
+
+
+</dt>
+<dd>
+  Orange Theme (Dark)
+This theme defines the color scheme, app bar, navigation bar, and other UI elements for the dark theme using the orange color palette.
+It is primarily used in dark mode interfaces.
+  <div class="features"><span class="feature">getter/setter pair</span></div>
+
+</dd>
+
+        <dt id="orangeThemeLight" class="property">
+  <span class="name"><a href="../core_ouds_theme/OudsTheme/orangeThemeLight.html">orangeThemeLight</a></span>
+  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/material/ThemeData-class.html">ThemeData</a></span>
+
+
+</dt>
+<dd>
+  Orange Theme (Light)
+This theme defines the color scheme, app bar, navigation bar, and other UI elements for the light theme using the orange color palette.
+It is primarily used in light mode interfaces.
+  <div class="features"><span class="feature">getter/setter pair</span></div>
+
+</dd>
+
+    </dl>
+  </section>
+
+
+
+  </div> <!-- /.main-content -->
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
+<header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+    <li><a href="../index.html">ouds_flutter</a></li>
+    <li><a href="../core_ouds_theme/core_ouds_theme-library.html">ouds_theme</a></li>
+    <li class="self-crumb">OudsTheme class</li>
+</ol>
+
+    <h5>ouds_theme library</h5>
+    <div id="dartdoc-sidebar-left-content"></div>
+  </div>
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div><!--/.sidebar-offcanvas-->
+</main>
+<footer>
+  <span class="no-break">
+    ouds_flutter
+      0.0.1
+  </span>
+
+</footer>
+
+
+<script src="../static-assets/highlight.pack.js?v1"></script>
+<script src="../static-assets/docs.dart.js"></script>
+
+</body>
+</html>
+