Deploying to gh-pages from @ 1d0e380 🚀

docs/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 0045b09a71380ec8eeaa8612b4b2af9b
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/index.rst.txt

@@ -0,0 +1,26 @@
+.. LightningAI-DevToolbox documentation master file, created by
+   sphinx-quickstart on Wed Mar 25 21:34:07 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Lightning-DevToolbox documentation
+==================================
+
+.. figure:: fetched-s3-assets/Lightning.gif
+    :alt: What is Lightning gif.
+    :width: 80 %
+
+.. toctree::
+   :maxdepth: 1
+   :name: content
+   :caption: Overview
+
+   Utilities readme <readme>
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/_sources/readme.md.txt

@@ -0,0 +1,138 @@
+# Lightning Utilities
+
+
+
+
+
+
+
+
+
+
+
+__This repository covers the following use-cases:__
+
+1. _Reusable GitHub workflows_
+2. _Shared GitHub actions_
+3. _General Python utilities in `lightning_utilities.core`_
+4. _CLI `python -m lightning_utilities.cli --help`_
+
+## 1. Reusable workflows
+
+__Usage:__
+
+```yaml
+name: Check schema
+
+on: [push]
+
+jobs:
+
+  check-schema:
+    uses: Lightning-AI/utilities/.github/workflows/[email protected]
+    with:
+      azure-dir: ""  # skip Azure check
+
+  check-code:
+    uses: Lightning-AI/utilities/.github/workflows/check-code.yml@main
+    with:
+      actions-ref: main  # normally you shall use the same version as the workflow
+```
+
+See usage of other workflows in [.github/workflows/ci-use-checks.yaml](https://github.com/Lightning-AI/utilities/tree/main/.github/workflows/ci-use-checks.yaml).
+
+## 2. Reusable composite actions
+
+See available composite actions [.github/actions/](https://github.com/Lightning-AI/utilities/tree/main/.github/actions).
+
+__Usage:__
+
+```yaml
+name: Do something with cache
+
+on: [push]
+
+jobs:
+  pytest:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+    - uses: Lightning-AI/utilities/.github/actions/cache
+      with:
+        python-version: 3.9
+        requires: oldest # or latest
+```
+
+## 3. General Python utilities `lightning_utilities.core`
+
+<details>
+  <summary>Installation</summary>
+From source:
+
+```bash
+pip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zip
+```
+
+From pypi:
+
+```bash
+pip install lightning_utilities
+```
+
+</details>
+
+__Usage:__
+
+Example for optional imports:
+
+```python
+from lightning_utilities.core.imports import module_available
+
+if module_available("some_package.something"):
+    from some_package import something
+```
+
+## 4. CLI `lightning_utilities.cli`
+
+The package provides common CLI commands.
+
+<details>
+  <summary>Installation</summary>
+
+From pypi:
+
+```bash
+pip install lightning_utilities[cli]
+```
+
+</details>
+
+__Usage:__
+
+```bash
+python -m lightning_utilities.cli [group] [command]
+```
+
+<details>
+  <summary>Example for setting min versions</summary>
+
+```console
+$ cat requirements/test.txt
+coverage>=5.0
+codecov>=2.1
+pytest>=6.0
+pytest-cov
+pytest-timeout
+$ python -m lightning_utilities.cli requirements set-oldest
+$ cat requirements/test.txt
+coverage==5.0
+codecov==2.1
+pytest==6.0
+pytest-cov
+pytest-timeout
+```
+
+</details>

docs/_sources/test-page.rst.txt

@@ -0,0 +1,8 @@
+:orphan:
+
+Testing page
+============
+
+This is some page serving exclusively for testing purposes.
+
+Link to scikit-learn stable documentation: https://scikit-learn.org/stable/index.html

docs/_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,134 @@
+/*
+ * _sphinx_javascript_frameworks_compat.js
+ * ~~~~~~~~~~
+ *
+ * Compatability shim for jQuery and underscores.js.
+ *
+ * WILL BE REMOVED IN Sphinx 6.0
+ * xref RemovedInSphinx60Warning
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}