iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs [bot]

Browse Source
This commit is contained in:
github-actions
2023-08-25 22:48:04 +00:00
parent 5391cb6a99
commit 445073d3e4
12 changed files with 100 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/_static/basic.css vendored
View File

@@ -237,6 +237,10 @@ a.headerlink {
visibility: hidden;
}
a:visited {
color: #551A8B;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
margin-left: 30px;
}
.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}
.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
cursor: help;
}
.translated {
background-color: rgba(207, 255, 207, 0.2)
}
.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}
/* -- code displays --------------------------------------------------------- */
pre {

3
docs/_static/documentation_options.js vendored
View File

@@ -1,5 +1,4 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
const DOCUMENTATION_OPTIONS = {
VERSION: '2.0.3',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,

26
docs/_static/searchtools.js vendored
View File

@@ -57,12 +57,12 @@ const _removeChildren = (element) => {
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
const _displayItem = (item, searchTerms) => {
const _displayItem = (item, searchTerms, highlightTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;
const [docName, title, anchor, descr, score, _filename] = item;
@@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = "";
requestUrl = docUrlRoot + dirname;
requestUrl = contentRoot + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = docUrlRoot + docName + docFileSuffix;
requestUrl = contentRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
if (descr)
if (descr) {
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
// highlight search terms in the description
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}
else if (showSearchSummary)
fetch(requestUrl)
.then((responseData) => responseData.text())
@@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
listItem.appendChild(
Search.makeSearchSummary(data, searchTerms)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
});
Search.output.appendChild(listItem);
};
@@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
const _displayNextItem = (
results,
resultCount,
searchTerms
searchTerms,
highlightTerms,
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
_displayItem(results.pop(), searchTerms);
_displayItem(results.pop(), searchTerms, highlightTerms);
setTimeout(
() => _displayNextItem(results, resultCount, searchTerms),
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
5
);
}
@@ -360,7 +368,7 @@ const Search = {
// console.info("search results:", Search.lastresults);
// print the results
_displayNextItem(results, results.length, searchTerms);
_displayNextItem(results, results.length, searchTerms, highlightTerms);
},
/**

16
docs/_static/sphinx_highlight.js vendored
View File

@@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore(
span,
parent.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
rest,
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
/* There may be more occurrences of search term in this node. So call this
* function recursively on the remaining fragment.
*/
_highlight(rest, addItems, text, className);
if (isInSVG) {
const rect = document.createElementNS(
@@ -140,5 +145,10 @@ const SphinxHighlight = {
},
};
_ready(SphinxHighlight.highlightSearchWords);
_ready(SphinxHighlight.initEscapeListener);
_ready(() => {
/* Do not call highlightSearchWords() when we are on the search page.
* It will highlight words from the *previous* search query.
*/
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
SphinxHighlight.initEscapeListener();
});

12
docs/about.html
View File

@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=664ffad9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="#" />
<link rel="index" title="Index" href="genindex.html" />
@@ -79,7 +79,7 @@
<div itemprop="articleBody">
<section id="about-inkycal">
<h1>About Inkycal<a class="headerlink" href="#about-inkycal" title="Permalink to this heading"></a></h1>
<h1>About Inkycal<a class="headerlink" href="#about-inkycal" title="Link to this heading"></a></h1>
<img align="center" src="https://raw.githubusercontent.com/aceisace/Inkycal/assets/Repo/logo.png" width="800" alt="inkycal logo"><p>Inkycal is a python3 software for selected E-Paper displays.
It’s open-source (non-commercially), fully modular, user-friendly and even runs
well even on the Raspberry Pi Zero. Inkycal even has a web-UI which takes

12
docs/dev_doc.html
View File

@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=664ffad9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
@@ -78,7 +78,7 @@
<div itemprop="articleBody">
<section id="developer-documentation">
<h1>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this heading"></a></h1>
<h1>Developer documentation<a class="headerlink" href="#developer-documentation" title="Link to this heading"></a></h1>
<p>This documentation is mainly for developers who wish to create a third party
module</p>
</section>

10
docs/genindex.html
View File

@@ -10,11 +10,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=664ffad9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="#" />

14
docs/index.html
View File

@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=664ffad9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
@@ -78,7 +78,7 @@
<div itemprop="articleBody">
<section id="inkycal-documentation">
<h1>Inkycal documentation<a class="headerlink" href="#inkycal-documentation" title="Permalink to this heading"></a></h1>
<h1>Inkycal documentation<a class="headerlink" href="#inkycal-documentation" title="Link to this heading"></a></h1>
<img alt="logo" src="https://raw.githubusercontent.com/aceisace/Inkycal/assets/Repo/logo.png" />
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
@@ -98,7 +98,7 @@
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>

18
docs/inkycal.html
View File

@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=664ffad9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
@@ -80,16 +80,16 @@
<img alt="logo" class="align-center" src="https://raw.githubusercontent.com/aceisace/Inkycal/assets/Repo/logo.png" />
<section id="inkycal">
<h1>Inkycal<a class="headerlink" href="#inkycal" title="Permalink to this heading"></a></h1>
<h1>Inkycal<a class="headerlink" href="#inkycal" title="Link to this heading"></a></h1>
</section>
<section id="display">
<h1>Display<a class="headerlink" href="#display" title="Permalink to this heading"></a></h1>
<h1>Display<a class="headerlink" href="#display" title="Link to this heading"></a></h1>
</section>
<section id="custom-functions">
<h1>Custom functions<a class="headerlink" href="#custom-functions" title="Permalink to this heading"></a></h1>
<h1>Custom functions<a class="headerlink" href="#custom-functions" title="Link to this heading"></a></h1>
</section>
<section id="helper-classes">
<h1>Helper classes<a class="headerlink" href="#helper-classes" title="Permalink to this heading"></a></h1>
<h1>Helper classes<a class="headerlink" href="#helper-classes" title="Link to this heading"></a></h1>
</section>

16
docs/quickstart.html
View File

@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=664ffad9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
@@ -83,9 +83,9 @@
<div itemprop="articleBody">
<section id="quickstart">
<h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this heading"></a></h1>
<h1>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h1>
<img align="center" src="https://raw.githubusercontent.com/aceinnolab/Inkycal/assets/Repo/logo.png" width="800"><section id="installing-inkycal">
<h2>Installing Inkycal<a class="headerlink" href="#installing-inkycal" title="Permalink to this heading"></a></h2>
<h2>Installing Inkycal<a class="headerlink" href="#installing-inkycal" title="Link to this heading"></a></h2>
<p>Install inkycal directly via the GitHub repo:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># clone the repo</span>
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/aceinnolab/Inkycal
@@ -99,7 +99,7 @@ pip3<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </
</div>
</section>
<section id="creating-settings-file">
<h2>Creating settings file<a class="headerlink" href="#creating-settings-file" title="Permalink to this heading"></a></h2>
<h2>Creating settings file<a class="headerlink" href="#creating-settings-file" title="Link to this heading"></a></h2>
<p>Please navigate to the <a class="reference external" href="https://aceisace.eu.pythonanywhere.com/index">WEB-UI</a> to create your settings file.</p>
<p>Copy the generated settings file to the Raspberry Pi
more coming soon..</p>

10
docs/search.html
View File

@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=664ffad9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>

2
docs/searchindex.js
View File

@@ -1 +1 @@
Search.setIndex({"docnames": ["about", "dev_doc", "index", "inkycal", "quickstart"], "filenames": ["about.md", "dev_doc.md", "index.rst", "inkycal.rst", "quickstart.md"], "titles": ["About Inkycal", "Developer documentation", "Inkycal documentation", "Inkycal", "Quickstart"], "terms": {"i": [0, 1], "python3": 0, "softwar": 0, "select": 0, "e": [0, 4], "paper": 0, "displai": [0, 2], "It": 0, "": 0, "open": 0, "sourc": 0, "non": 0, "commerci": 0, "fulli": 0, "modular": 0, "user": 0, "friendli": 0, "even": 0, "run": 0, "well": 0, "raspberri": [0, 4], "pi": [0, 4], "zero": 0, "ha": 0, "web": [0, 4], "ui": [0, 4], "which": 0, "take": 0, "care": 0, "ad": 0, "your": [0, 4], "detail": 0, "No": 0, "more": [0, 4], "edit": 0, "file": [0, 2], "yai": 0, "parti": [0, 1], "_": 0, "face": 0, "The": 0, "main": 0, "idea": 0, "behind": 0, "wa": 0, "creat": [0, 1, 2], "dashboard": 0, "blend": 0, "its": 0, "environ": 0, "show": 0, "you": 0, "all": 0, "inform": 0, "without": 0, "have": 0, "look": 0, "them": 0, "up": 0, "sever": 0, "built": 0, "modul": [0, 1, 2], "help": 0, "stai": 0, "organis": 0, "provid": 0, "weather": 0, "forecast": 0, "full": 0, "week": 0, "next": 0, "few": 0, "hour": 0, "get": 0, "latest": 0, "new": 0, "from": 0, "atom": 0, "rss": 0, "feed": 0, "icalendar": 0, "agenda": 0, "mai": 0, "synchronis": 0, "phone": 0, "monthli": 0, "calendar": 0, "also": 0, "event": 0, "sync": 0, "googl": 0, "etc": 0, "fetch": 0, "some": 0, "joke": 0, "form": 0, "smile": 0, "what": 0, "compat": 0, "third": [0, 1], "someth": 0, "miss": 0, "can": 0, "write": 0, "own": 0, "share": 0, "commun": 0, "discord": 0, "case": 0, "re": 0, "pinch": 0, "set": [0, 2], "noob": 0, "welcom": 0, "too": 0, "cours": 0, "develop": [0, 2], "mainli": [0, 1], "aceisac": 0, "univers": 0, "student": 0, "other": 0, "free": 0, "time": 0, "mean": 0, "we": 0, "work": 0, "noth": 0, "doesn": 0, "t": 0, "don": 0, "need": 0, "anyth": 0, "invest": 0, "larg": 0, "amount": 0, "effort": 0, "coffe": 0, "pleas": [0, 4], "support": 0, "via": [0, 4], "donat": 0, "u": 0, "keep": 0, "thi": [0, 1], "project": 0, "aliv": 0, "thank": 0, "who": 1, "wish": 1, "custom": 2, "function": 2, "helper": 2, "class": 2, "about": 2, "quickstart": 2, "instal": 2, "index": 2, "search": 2, "page": 2, "directli": 4, "github": 4, "repo": 4, "clone": 4, "git": 4, "http": 4, "com": 4, "aceinnolab": 4, "go": 4, "download": 4, "folder": 4, "cd": 4, "pip3": 4, "navig": 4, "copi": 4, "gener": 4, "come": 4, "soon": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"about": 0, "inkyc": [0, 2, 3, 4], "develop": 1, "document": [1, 2], "content": 2, "indic": 2, "tabl": 2, "displai": 3, "custom": 3, "function": 3, "helper": 3, "class": 3, "quickstart": 4, "instal": 4, "creat": 4, "set": 4, "file": 4}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"About Inkycal": [[0, "about-inkycal"]], "Developer documentation": [[1, "developer-documentation"]], "Inkycal documentation": [[2, "inkycal-documentation"]], "Contents:": [[2, null]], "Indices and tables": [[2, "indices-and-tables"]], "Quickstart": [[4, "quickstart"]], "Installing Inkycal": [[4, "installing-inkycal"]], "Creating settings file": [[4, "creating-settings-file"]], "Inkycal": [[3, "inkycal"]], "Display": [[3, "display"]], "Custom functions": [[3, "custom-functions"]], "Helper classes": [[3, "helper-classes"]]}, "indexentries": {}})
Search.setIndex({"docnames": ["about", "dev_doc", "index", "inkycal", "quickstart"], "filenames": ["about.md", "dev_doc.md", "index.rst", "inkycal.rst", "quickstart.md"], "titles": ["About Inkycal", "Developer documentation", "Inkycal documentation", "Inkycal", "Quickstart"], "terms": {"i": [0, 1], "python3": 0, "softwar": 0, "select": 0, "e": [0, 4], "paper": 0, "displai": [0, 2], "It": 0, "": 0, "open": 0, "sourc": 0, "non": 0, "commerci": 0, "fulli": 0, "modular": 0, "user": 0, "friendli": 0, "even": 0, "run": 0, "well": 0, "raspberri": [0, 4], "pi": [0, 4], "zero": 0, "ha": 0, "web": [0, 4], "ui": [0, 4], "which": 0, "take": 0, "care": 0, "ad": 0, "your": [0, 4], "detail": 0, "No": 0, "more": [0, 4], "edit": 0, "file": [0, 2], "yai": 0, "parti": [0, 1], "_": 0, "face": 0, "The": 0, "main": 0, "idea": 0, "behind": 0, "wa": 0, "creat": [0, 1, 2], "dashboard": 0, "blend": 0, "its": 0, "environ": 0, "show": 0, "you": 0, "all": 0, "inform": 0, "without": 0, "have": 0, "look": 0, "them": 0, "up": 0, "sever": 0, "built": 0, "modul": [0, 1, 2], "help": 0, "stai": 0, "organis": 0, "provid": 0, "weather": 0, "forecast": 0, "full": 0, "week": 0, "next": 0, "few": 0, "hour": 0, "get": 0, "latest": 0, "new": 0, "from": 0, "atom": 0, "rss": 0, "feed": 0, "icalendar": 0, "agenda": 0, "mai": 0, "synchronis": 0, "phone": 0, "monthli": 0, "calendar": 0, "also": 0, "event": 0, "sync": 0, "googl": 0, "etc": 0, "fetch": 0, "some": 0, "joke": 0, "form": 0, "smile": 0, "what": 0, "compat": 0, "third": [0, 1], "someth": 0, "miss": 0, "can": 0, "write": 0, "own": 0, "share": 0, "commun": 0, "discord": 0, "case": 0, "re": 0, "pinch": 0, "set": [0, 2], "noob": 0, "welcom": 0, "too": 0, "cours": 0, "develop": [0, 2], "mainli": [0, 1], "aceisac": 0, "univers": 0, "student": 0, "other": 0, "free": 0, "time": 0, "mean": 0, "we": 0, "work": 0, "noth": 0, "doesn": 0, "t": 0, "don": 0, "need": 0, "anyth": 0, "invest": 0, "larg": 0, "amount": 0, "effort": 0, "coffe": 0, "pleas": [0, 4], "support": 0, "via": [0, 4], "donat": 0, "u": 0, "keep": 0, "thi": [0, 1], "project": 0, "aliv": 0, "thank": 0, "who": 1, "wish": 1, "custom": 2, "function": 2, "helper": 2, "class": 2, "about": 2, "quickstart": 2, "instal": 2, "index": 2, "search": 2, "page": 2, "directli": 4, "github": 4, "repo": 4, "clone": 4, "git": 4, "http": 4, "com": 4, "aceinnolab": 4, "go": 4, "download": 4, "folder": 4, "cd": 4, "pip3": 4, "navig": 4, "copi": 4, "gener": 4, "come": 4, "soon": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"about": 0, "inkyc": [0, 2, 3, 4], "develop": 1, "document": [1, 2], "content": 2, "indic": 2, "tabl": 2, "displai": 3, "custom": 3, "function": 3, "helper": 3, "class": 3, "quickstart": 4, "instal": 4, "creat": 4, "set": 4, "file": 4}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"About Inkycal": [[0, "about-inkycal"]], "Developer documentation": [[1, "developer-documentation"]], "Inkycal documentation": [[2, "inkycal-documentation"]], "Contents:": [[2, null]], "Indices and tables": [[2, "indices-and-tables"]], "Quickstart": [[4, "quickstart"]], "Installing Inkycal": [[4, "installing-inkycal"]], "Creating settings file": [[4, "creating-settings-file"]], "Inkycal": [[3, "inkycal"]], "Display": [[3, "display"]], "Custom functions": [[3, "custom-functions"]], "Helper classes": [[3, "helper-classes"]]}, "indexentries": {}})