Deployed 03636627 to nightly with MkDocs 1.5.3 and mike 2.0.0

This commit is contained in:
github-actions[bot] 2023-11-16 08:17:45 +00:00
parent 24170e3893
commit 17e2afc616
33 changed files with 206 additions and 115 deletions

View File

@ -15,7 +15,7 @@
<link rel="icon" href="/bottom/nightly/assets/images/favicon.png"> <link rel="icon" href="/bottom/stable/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8"> <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8">
@ -24,10 +24,10 @@
<link rel="stylesheet" href="/bottom/nightly/assets/stylesheets/main.4b4a2bd9.min.css"> <link rel="stylesheet" href="/bottom/stable/assets/stylesheets/main.4b4a2bd9.min.css">
<link rel="stylesheet" href="/bottom/nightly/assets/stylesheets/palette.356b1318.min.css"> <link rel="stylesheet" href="/bottom/stable/assets/stylesheets/palette.356b1318.min.css">
@ -46,9 +46,9 @@
<link rel="stylesheet" href="/bottom/nightly/stylesheets/extra.css"> <link rel="stylesheet" href="/bottom/stable/stylesheets/extra.css">
<script>__md_scope=new URL("/bottom/nightly",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> <script>__md_scope=new URL("/bottom/stable",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@ -90,7 +90,7 @@
<header class="md-header" data-md-component="header"> <header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header"> <nav class="md-header__inner md-grid" aria-label="Header">
<a href="/bottom/nightly/." title="bottom" class="md-header__button md-logo" aria-label="bottom" data-md-component="logo"> <a href="/bottom/stable/." title="bottom" class="md-header__button md-logo" aria-label="bottom" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
@ -216,7 +216,7 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/bottom/nightly/." class="md-tabs__link"> <a href="/bottom/stable/." class="md-tabs__link">
@ -235,7 +235,7 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/bottom/nightly/support/official/" class="md-tabs__link"> <a href="/bottom/stable/support/official/" class="md-tabs__link">
Support Support
@ -253,7 +253,7 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/bottom/nightly/usage/general-usage/" class="md-tabs__link"> <a href="/bottom/stable/usage/general-usage/" class="md-tabs__link">
Usage Usage
@ -271,7 +271,7 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/bottom/nightly/configuration/command-line-flags/" class="md-tabs__link"> <a href="/bottom/stable/configuration/command-line-flags/" class="md-tabs__link">
Configuration Configuration
@ -289,7 +289,7 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/bottom/nightly/contribution/issues-and-pull-requests/" class="md-tabs__link"> <a href="/bottom/stable/contribution/issues-and-pull-requests/" class="md-tabs__link">
Contribution Contribution
@ -305,7 +305,7 @@
<li class="md-tabs__item"> <li class="md-tabs__item">
<a href="/bottom/nightly/troubleshooting/" class="md-tabs__link"> <a href="/bottom/stable/troubleshooting/" class="md-tabs__link">
@ -341,7 +341,7 @@
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0"> <nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer"> <label class="md-nav__title" for="__drawer">
<a href="/bottom/nightly/." title="bottom" class="md-nav__button md-logo" aria-label="bottom" data-md-component="logo"> <a href="/bottom/stable/." title="bottom" class="md-nav__button md-logo" aria-label="bottom" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
@ -370,7 +370,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/." class="md-nav__link"> <a href="/bottom/stable/." class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -430,7 +430,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/support/official/" class="md-nav__link"> <a href="/bottom/stable/support/official/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -450,7 +450,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/support/unofficial/" class="md-nav__link"> <a href="/bottom/stable/support/unofficial/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -518,7 +518,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/general-usage/" class="md-nav__link"> <a href="/bottom/stable/usage/general-usage/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -538,7 +538,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/basic-mode/" class="md-nav__link"> <a href="/bottom/stable/usage/basic-mode/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -599,7 +599,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/widgets/cpu/" class="md-nav__link"> <a href="/bottom/stable/usage/widgets/cpu/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -619,7 +619,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/widgets/memory/" class="md-nav__link"> <a href="/bottom/stable/usage/widgets/memory/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -639,7 +639,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/widgets/network/" class="md-nav__link"> <a href="/bottom/stable/usage/widgets/network/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -659,7 +659,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/widgets/process/" class="md-nav__link"> <a href="/bottom/stable/usage/widgets/process/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -679,7 +679,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/widgets/disk/" class="md-nav__link"> <a href="/bottom/stable/usage/widgets/disk/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -699,7 +699,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/widgets/temperature/" class="md-nav__link"> <a href="/bottom/stable/usage/widgets/temperature/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -719,7 +719,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/usage/widgets/battery/" class="md-nav__link"> <a href="/bottom/stable/usage/widgets/battery/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -795,7 +795,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/configuration/command-line-flags/" class="md-nav__link"> <a href="/bottom/stable/configuration/command-line-flags/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -856,7 +856,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/configuration/config-file/default-config/" class="md-nav__link"> <a href="/bottom/stable/configuration/config-file/default-config/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -876,7 +876,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/configuration/config-file/flags/" class="md-nav__link"> <a href="/bottom/stable/configuration/config-file/flags/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -896,7 +896,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/configuration/config-file/theming/" class="md-nav__link"> <a href="/bottom/stable/configuration/config-file/theming/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -916,7 +916,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/configuration/config-file/layout/" class="md-nav__link"> <a href="/bottom/stable/configuration/config-file/layout/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -936,7 +936,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/configuration/config-file/data-filtering/" class="md-nav__link"> <a href="/bottom/stable/configuration/config-file/data-filtering/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -956,7 +956,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/configuration/config-file/processes/" class="md-nav__link"> <a href="/bottom/stable/configuration/config-file/processes/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1032,7 +1032,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/issues-and-pull-requests/" class="md-nav__link"> <a href="/bottom/stable/contribution/issues-and-pull-requests/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1052,7 +1052,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/documentation/" class="md-nav__link"> <a href="/bottom/stable/contribution/documentation/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1072,7 +1072,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/packaging-and-distribution/" class="md-nav__link"> <a href="/bottom/stable/contribution/packaging-and-distribution/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1133,7 +1133,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/development/dev_env/" class="md-nav__link"> <a href="/bottom/stable/contribution/development/dev_env/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1153,7 +1153,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/development/testing/" class="md-nav__link"> <a href="/bottom/stable/contribution/development/testing/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1173,7 +1173,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/development/logging/" class="md-nav__link"> <a href="/bottom/stable/contribution/development/logging/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1193,7 +1193,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/development/build_process/" class="md-nav__link"> <a href="/bottom/stable/contribution/development/build_process/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1213,7 +1213,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/contribution/development/deploy_process/" class="md-nav__link"> <a href="/bottom/stable/contribution/development/deploy_process/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1248,7 +1248,7 @@
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/bottom/nightly/troubleshooting/" class="md-nav__link"> <a href="/bottom/stable/troubleshooting/" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
@ -1313,10 +1313,10 @@
</div> </div>
<script id="__config" type="application/json">{"base": "/bottom/nightly", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "navigation.sections", "toc.integrate", "search.suggest", "search.highlight"], "search": "/bottom/nightly/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "stable", "provider": "mike"}}</script> <script id="__config" type="application/json">{"base": "/bottom/stable", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "navigation.sections", "toc.integrate", "search.suggest", "search.highlight"], "search": "/bottom/stable/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "stable", "provider": "mike"}}</script>
<script src="/bottom/nightly/assets/javascripts/bundle.81fa17fe.min.js"></script> <script src="/bottom/stable/assets/javascripts/bundle.81fa17fe.min.js"></script>
</body> </body>

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/command-line-flags/">
<link rel="prev" href="../../usage/widgets/battery/"> <link rel="prev" href="../../usage/widgets/battery/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/configuration/config-file/data-filtering/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/data-filtering/">
<link rel="prev" href="../layout/"> <link rel="prev" href="../layout/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/default-config/">
<link rel="prev" href="../../command-line-flags/"> <link rel="prev" href="../../command-line-flags/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/configuration/config-file/flags/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/flags/">
<link rel="prev" href="../default-config/"> <link rel="prev" href="../default-config/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/configuration/config-file/layout/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/layout/">
<link rel="prev" href="../theming/"> <link rel="prev" href="../theming/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/configuration/config-file/processes/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/processes/">
<link rel="prev" href="../data-filtering/"> <link rel="prev" href="../data-filtering/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/configuration/config-file/theming/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/theming/">
<link rel="prev" href="../flags/"> <link rel="prev" href="../flags/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/development/build_process/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/development/build_process/">
<link rel="prev" href="../logging/"> <link rel="prev" href="../logging/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/development/deploy_process/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/development/deploy_process/">
<link rel="prev" href="../build_process/"> <link rel="prev" href="../build_process/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/development/dev_env/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/development/dev_env/">
<link rel="prev" href="../../packaging-and-distribution/"> <link rel="prev" href="../../packaging-and-distribution/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/development/logging/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/development/logging/">
<link rel="prev" href="../testing/"> <link rel="prev" href="../testing/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/development/testing/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/development/testing/">
<link rel="prev" href="../dev_env/"> <link rel="prev" href="../dev_env/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/documentation/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/documentation/">
<link rel="prev" href="../issues-and-pull-requests/"> <link rel="prev" href="../issues-and-pull-requests/">
@ -1383,27 +1383,20 @@
well as link to the relevant PR or issue.</p> well as link to the relevant PR or issue.</p>
<h3>Help menu</h3> <h3>Help menu</h3>
<p>For changes to the help menu, try to refer to the existing code within <code>src/constants.rs</code> on how the help menu is generated.</p> <p>For changes to the help menu, try to refer to the existing code within <a href="https://github.com/ClementTsang/bottom/blob/master/src/constants.rs"><code>src/constants.rs</code></a> on how the help menu is generated.</p>
<h3>Extended documentation</h3> <h3>Extended documentation</h3>
<p>For changes to the extended documentation, you'll probably want Python 3.11 (older versions should be fine though), <p>For changes to the extended documentation, you'll probably want at least Python 3.11 (older versions should be fine
<a href="https://www.mkdocs.org/">MkDocs</a>, <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>, though), <a href="https://www.mkdocs.org/">MkDocs</a>, <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>,
<code>mdx_truly_sane_lists</code>, and optionally <a href="https://github.com/jimporter/mike">Mike</a> installed to provide live reloading <code>mdx_truly_sane_lists</code>, and optionally <a href="https://github.com/jimporter/mike">Mike</a> installed. These can help with
and preview for your changes. They aren't needed, but it'll help with validating your changes.</p> validating your changes locally.</p>
<p>You can do so through <code>pip</code> or your system's package managers. If you use <code>pip</code>, you can use venv to cleanly install <p>You can do so through <code>pip</code> or your system's package managers. If you use <code>pip</code>, you can use venv to cleanly install
the documentation dependencies:</p> the documentation dependencies:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Change directories to the documentation.</span> <div class="highlight"><pre><span></span><code><span class="c1"># Change directories to the documentation.</span>
<span class="nb">cd</span><span class="w"> </span>docs/ <span class="nb">cd</span><span class="w"> </span>docs/
<span class="c1"># Create and activate venv.</span> <span class="w"> </span><span class="c1"># Create venv, install the dependencies, and serve the page.</span>
python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>venv ./serve.sh
<span class="nb">source</span><span class="w"> </span>venv/bin/activate
<span class="c1"># Install requirements</span>
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
<span class="c1"># Run mkdocs</span>
venv/bin/mkdocs<span class="w"> </span>serve
</code></pre></div> </code></pre></div>
<p>This will serve a local version of the docs that you can open on your browser. It will update as you make changes.</p> <p>This will serve a local version of the docs that you can open on your browser. It will update as you make changes.</p>
</li> </li>

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/issues-and-pull-requests/">
<link rel="prev" href="../../configuration/config-file/processes/"> <link rel="prev" href="../../configuration/config-file/processes/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/contribution/packaging-and-distribution/">
<link rel="prev" href="../documentation/"> <link rel="prev" href="../documentation/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/">

File diff suppressed because one or more lines are too long

View File

@ -1,142 +1,142 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/</loc> <loc>https://clementtsang.github.io/bottom/stable/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/troubleshooting/</loc> <loc>https://clementtsang.github.io/bottom/stable/troubleshooting/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/</loc> <loc>https://clementtsang.github.io/bottom/stable/configuration/command-line-flags/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/data-filtering/</loc> <loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/data-filtering/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/</loc> <loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/default-config/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/flags/</loc> <loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/flags/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/layout/</loc> <loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/layout/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/processes/</loc> <loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/processes/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/theming/</loc> <loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/theming/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/documentation/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/documentation/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/issues-and-pull-requests/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/packaging-and-distribution/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/build_process/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/development/build_process/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/deploy_process/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/development/deploy_process/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/dev_env/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/development/dev_env/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/logging/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/development/logging/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/testing/</loc> <loc>https://clementtsang.github.io/bottom/stable/contribution/development/testing/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/support/official/</loc> <loc>https://clementtsang.github.io/bottom/stable/support/official/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/support/unofficial/</loc> <loc>https://clementtsang.github.io/bottom/stable/support/unofficial/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/basic-mode/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/basic-mode/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/general-usage/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/general-usage/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/widgets/battery/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/widgets/cpu/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/widgets/disk/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/widgets/memory/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/network/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/widgets/network/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/process/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/widgets/process/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/</loc> <loc>https://clementtsang.github.io/bottom/stable/usage/widgets/temperature/</loc>
<lastmod>2023-11-16</lastmod> <lastmod>2023-11-16</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>

Binary file not shown.

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/support/official/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/support/official/">
<link rel="prev" href="../.."> <link rel="prev" href="../..">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/support/unofficial/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/support/unofficial/">
<link rel="prev" href="../official/"> <link rel="prev" href="../official/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/troubleshooting/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/troubleshooting/">
<link rel="prev" href="../contribution/development/deploy_process/"> <link rel="prev" href="../contribution/development/deploy_process/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/basic-mode/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/basic-mode/">
<link rel="prev" href="../general-usage/"> <link rel="prev" href="../general-usage/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/general-usage/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/general-usage/">
<link rel="prev" href="../../support/unofficial/"> <link rel="prev" href="../../support/unofficial/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/widgets/battery/">
<link rel="prev" href="../temperature/"> <link rel="prev" href="../temperature/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/widgets/cpu/">
<link rel="prev" href="../../basic-mode/"> <link rel="prev" href="../../basic-mode/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/widgets/disk/">
<link rel="prev" href="../process/"> <link rel="prev" href="../process/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/widgets/memory/">
<link rel="prev" href="../cpu/"> <link rel="prev" href="../cpu/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/widgets/network/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/widgets/network/">
<link rel="prev" href="../memory/"> <link rel="prev" href="../memory/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/widgets/process/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/widgets/process/">
<link rel="prev" href="../network/"> <link rel="prev" href="../network/">

View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang"> <meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/"> <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/usage/widgets/temperature/">
<link rel="prev" href="../disk/"> <link rel="prev" href="../disk/">

View File

@ -1 +1,99 @@
[{"version": "0.9.6", "title": "0.9.6 (stable)", "aliases": ["stable"]}, {"version": "0.9.5", "title": "0.9.5", "aliases": []}, {"version": "0.9.4", "title": "0.9.4", "aliases": []}, {"version": "0.9.3", "title": "0.9.3", "aliases": []}, {"version": "0.9.2", "title": "0.9.2", "aliases": []}, {"version": "0.9.1", "title": "0.9.1", "aliases": []}, {"version": "0.9.0", "title": "0.9.0", "aliases": []}, {"version": "0.8.0", "title": "0.8.0", "aliases": []}, {"version": "0.7.1", "title": "0.7.1", "aliases": []}, {"version": "0.7.0", "title": "0.7.0", "aliases": []}, {"version": "0.6.8", "title": "0.6.8", "aliases": []}, {"version": "0.6.7", "title": "0.6.7", "aliases": []}, {"version": "0.6.6", "title": "0.6.6", "aliases": []}, {"version": "0.6.5", "title": "0.6.5", "aliases": []}, {"version": "0.6.4", "title": "0.6.4", "aliases": []}, {"version": "0.6.3", "title": "0.6.3", "aliases": []}, {"version": "0.6.2", "title": "0.6.2", "aliases": []}, {"version": "0.6.1", "title": "0.6.1", "aliases": []}, {"version": "nightly", "title": "nightly", "aliases": []}] [
{
"version": "nightly",
"title": "nightly",
"aliases": []
},
{
"version": "0.9.6",
"title": "0.9.6 (stable)",
"aliases": [
"stable"
]
},
{
"version": "0.9.5",
"title": "0.9.5",
"aliases": []
},
{
"version": "0.9.4",
"title": "0.9.4",
"aliases": []
},
{
"version": "0.9.3",
"title": "0.9.3",
"aliases": []
},
{
"version": "0.9.2",
"title": "0.9.2",
"aliases": []
},
{
"version": "0.9.1",
"title": "0.9.1",
"aliases": []
},
{
"version": "0.9.0",
"title": "0.9.0",
"aliases": []
},
{
"version": "0.8.0",
"title": "0.8.0",
"aliases": []
},
{
"version": "0.7.1",
"title": "0.7.1",
"aliases": []
},
{
"version": "0.7.0",
"title": "0.7.0",
"aliases": []
},
{
"version": "0.6.8",
"title": "0.6.8",
"aliases": []
},
{
"version": "0.6.7",
"title": "0.6.7",
"aliases": []
},
{
"version": "0.6.6",
"title": "0.6.6",
"aliases": []
},
{
"version": "0.6.5",
"title": "0.6.5",
"aliases": []
},
{
"version": "0.6.4",
"title": "0.6.4",
"aliases": []
},
{
"version": "0.6.3",
"title": "0.6.3",
"aliases": []
},
{
"version": "0.6.2",
"title": "0.6.2",
"aliases": []
},
{
"version": "0.6.1",
"title": "0.6.1",
"aliases": []
}
]