Deployed dab4b6c4 to nightly with MkDocs 1.5.3 and mike 2.0.0

This commit is contained in:
github-actions[bot] 2023-12-06 05:16:53 +00:00
parent 95c6d2b9bf
commit cfee12c4bf
11 changed files with 55 additions and 55 deletions

View File

@ -1377,7 +1377,7 @@ represents a <em>widget</em>. A widget is represented by having a <code>type</co
</table>
<p>Each component of the layout accepts a <code>ratio</code> value. If this is not set, it defaults to 1.</p>
<p>Furthermore, you can have duplicate widgets.</p>
<p>For an example, look at the <a href="https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml">default config</a>, which contains the default layout.</p>
<p>For an example, look at the <a href="https://github.com/ClementTsang/bottom/blob/main/sample_configs/default_config.toml">default config</a>, which contains the default layout.</p>

View File

@ -1370,14 +1370,14 @@
<p>This section is intended for people who wish to work on/build/distribute bottom, not general users.</p>
</div>
<h2 id="overview"><a class="toclink" href="#overview">Overview</a></h2>
<p>bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a>, called by a wrapper workflow for <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml">nightly</a> and <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml">stable</a> releases. Builds take place via GitHub Actions.</p>
<p>bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a>, called by a wrapper workflow for <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml">nightly</a> and <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml">stable</a> releases. Builds take place via GitHub Actions.</p>
<p>The main things built are:</p>
<ul>
<li>Binaries for various platforms</li>
<li>MSI installer for Windows</li>
<li><code>.deb</code> package for Debian and its derivatives</li>
</ul>
<p>This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a> file.</p>
<p>This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a> file.</p>
<h2 id="binaries"><a class="toclink" href="#binaries">Binaries</a></h2>
<p>Binaries are built currently for various targets. Note that not all of these are officially supported. The following general steps are performed:</p>
<ul>

View File

@ -1385,9 +1385,9 @@
<h2 id="overview"><a class="toclink" href="#overview">Overview</a></h2>
<p>bottom currently has two main deploy processes to worry about:</p>
<ul>
<li><a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml">Nightly</a>: a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the <a href="https://github.com/ClementTsang/bottom/releases/tag/nightly">nightly release</a>. It can also be triggered manually as either a proper nightly release or a mock release.</li>
<li><a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml">Nightly</a>: a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the <a href="https://github.com/ClementTsang/bottom/releases/tag/nightly">nightly release</a>. It can also be triggered manually as either a proper nightly release or a mock release.</li>
<li>
<p><a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml">Stable</a>: a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release.</p>
<p><a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml">Stable</a>: a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release.</p>
<p>Furthermore, this workflow does not handle the following deployments, which must be manually handled:</p>
<ul>
<li><a href="https://community.chocolatey.org/packages/bottom">Chocolatey</a></li>

View File

@ -1363,10 +1363,10 @@
<h2 id="what-pages-need-documentation"><a class="toclink" href="#what-pages-need-documentation">What pages need documentation?</a></h2>
<p>There are a few areas where documentation changes are often needed:</p>
<ul>
<li>The <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a></li>
<li>The help menu inside of the application (located <a href="https://github.com/ClementTsang/bottom/blob/master/src/constants.rs">here</a>)</li>
<li>The <a href="https://github.com/ClementTsang/bottom/blob/main/README.md"><code>README.md</code></a></li>
<li>The help menu inside of the application (located <a href="https://github.com/ClementTsang/bottom/blob/main/src/constants.rs">here</a>)</li>
<li>The <a href="https://clementtsang.github.io/bottom/nightly/">extended documentation</a> (here)</li>
<li>The <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a></li>
<li>The <a href="https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md"><code>CHANGELOG.md</code></a></li>
</ul>
<h2 id="how-should-i-addupdate-documentation"><a class="toclink" href="#how-should-i-addupdate-documentation">How should I add/update documentation?</a></h2>
<ol>
@ -1377,17 +1377,17 @@
<p>Where you're adding documentation will probably affect what you need to do:</p>
<h3><code>README.md</code> or <code>CHANGELOG.md</code></h3>
<p>For changes to <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a> and <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a>, just follow the formatting provided and use any editor.</p>
<p>Generally, changes to <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a> will be handled
by a maintainer, and changes should follow the <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a> format, as
well as link to the relevant PR or issue.</p>
<p>For changes to <a href="https://github.com/ClementTsang/bottom/blob/main/README.md"><code>README.md</code></a> and <a href="https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md"><code>CHANGELOG.md</code></a>, just follow the formatting provided and use any editor.</p>
<p>Generally, changes to <a href="https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md"><code>CHANGELOG.md</code></a> will be handled
by a maintainer, and the contents of the file should follow the <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>
format, as well as link to the relevant PR or issues.</p>
<h3>Help menu</h3>
<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>
<p>For changes to the help menu, try to refer to the existing code within <a href="https://github.com/ClementTsang/bottom/blob/main/src/constants.rs"><code>src/constants.rs</code></a> on how the help menu is generated.</p>
<h3>Extended documentation</h3>
<p>For changes to the extended documentation, you'll probably want at least Python 3.11 (older versions should be fine
though), <a href="https://www.mkdocs.org/">MkDocs</a>, <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>,
<p>For changes to the extended documentation, you'll probably want at least Python 3.11 (older and newer versions
should be fine), <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. These can help with
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

View File

@ -1392,7 +1392,7 @@
<li>Fork the project.</li>
<li>Make your changes.</li>
<li>Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See <a href="../documentation/">here</a> for tips on documentation.</li>
<li>Commit and create a pull request to merge into the <code>master</code> branch. <strong>Please fill out the pull request template</strong>.</li>
<li>Commit and create a pull request to merge into the <code>main</code> branch. <strong>Please fill out the pull request template</strong>.</li>
<li>Ask a maintainer to review your pull request.<ul>
<li>Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a
first-time contributor, you may need to wait for a maintainer to let CI run.</li>

View File

@ -1375,9 +1375,9 @@ find pre-built binaries in either a <code>tar.gz</code> or <code>zip</code> form
completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging
process.</p>
<p>You can also find a nightly build in the <a href="https://github.com/ClementTsang/bottom/releases">releases page</a>, built every
day at 00:00 UTC off of the master branch.</p>
day at 00:00 UTC off of the <code>main</code> branch.</p>
<p>In both cases, we use a combination of GitHub Actions and CirrusCI (mainly for FreeBSD and macOS M1) to create our
release binaries. <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a>
release binaries. <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a>
contains the GitHub Action workflow used to do both of these, if reference is needed.</p>
<h2 id="building-manually"><a class="toclink" href="#building-manually">Building manually</a></h2>
<p>If you want to manually build bottom rather than distributing a pre-built binary, you'll need the most recent version
@ -1388,7 +1388,7 @@ of stable Rust, which you can get with:</p>
<div class="highlight"><pre><span></span><code>cargo<span class="w"> </span>build<span class="w"> </span>--release<span class="w"> </span>--locked
</code></pre></div>
<h3 id="manpage-and-completion-generation"><a class="toclink" href="#manpage-and-completion-generation">Manpage and completion generation</a></h3>
<p>bottom uses a <a href="https://github.com/ClementTsang/bottom/blob/master/build.rs"><code>build.rs</code></a> script to automatically generate
<p>bottom uses a <a href="https://github.com/ClementTsang/bottom/blob/main/build.rs"><code>build.rs</code></a> script to automatically generate
a manpage and shell completions for the following shells:</p>
<ul>
<li>Bash</li>
@ -1404,11 +1404,11 @@ example, run something like this:</p>
<p>This will automatically generate completion and manpage files in <code>target/tmp/bottom/</code>. If you wish to regenerate the
files, modify/delete either these files or set <code>BTM_GENERATE</code> to some other non-empty value to retrigger the build
script.</p>
<p>For more information, you may want to look at either the <a href="https://github.com/ClementTsang/bottom/blob/master/build.rs"><code>build.rs</code></a>
file or the <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml">binary build CI workflow</a>.</p>
<p>For more information, you may want to look at either the <a href="https://github.com/ClementTsang/bottom/blob/main/build.rs"><code>build.rs</code></a>
file or the <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml">binary build CI workflow</a>.</p>
<h2 id="adding-an-installation-source"><a class="toclink" href="#adding-an-installation-source">Adding an installation source</a></h2>
<p>Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add
the installation method and any details to the <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a>
the installation method and any details to the <a href="https://github.com/ClementTsang/bottom/blob/main/README.md"><code>README.md</code></a>
file under the <a href="https://github.com/ClementTsang/bottom#installation">Installation</a> section, as well as a corresponding
table of contents entry. Once that's done, open a pull request - these will usually be approved of very quickly.</p>
<p>You can find more info on the contribution process <a href="../issues-and-pull-requests/#pull-requests">here</a>.</p>

File diff suppressed because one or more lines are too long

View File

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

Binary file not shown.

View File

@ -1346,9 +1346,9 @@ on the problem at the end of the day, <em>issues on unsupported platforms are li
<p>Unofficially supported platforms known to compile/work:</p>
<ul>
<li>FreeBSD</li>
<li>Linux on ARMv7 and ARMv6 (tested to compile in <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml">CI</a>)</li>
<li>Linux on PowerPC 64 LE (tested to compile in <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml">CI</a>)</li>
<li>Linux on an RISC-V (tested to compile in <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml">CI</a>, tested to run on an <a href="https://github.com/ClementTsang/bottom/issues/564">Allwinner D1 Nezha</a>)</li>
<li>Linux on ARMv7 and ARMv6 (tested to compile in <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml">CI</a>)</li>
<li>Linux on PowerPC 64 LE (tested to compile in <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml">CI</a>)</li>
<li>Linux on an RISC-V (tested to compile in <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/ci.yml">CI</a>, tested to run on an <a href="https://github.com/ClementTsang/bottom/issues/564">Allwinner D1 Nezha</a>)</li>
</ul>
<h2 id="known-problems"><a class="toclink" href="#known-problems">Known problems</a></h2>
<p>None at the moment.</p>

View File

@ -1509,7 +1509,7 @@ on how to run htop without sudo for bottom. However, <strong>please</strong> und
<h2 id="my-configuration-file-isnt-working"><a class="toclink" href="#my-configuration-file-isnt-working">My configuration file isn't working</a></h2>
<p>If your configuration files aren't working, here are a few things to try:</p>
<h3 id="check-the-formatting"><a class="toclink" href="#check-the-formatting">Check the formatting</a></h3>
<p>It may be handy to refer to the automatically generated config files or the <a href="https://github.com/ClementTsang/bottom/tree/master/sample_configs">sample configuration files</a>.
<p>It may be handy to refer to the automatically generated config files or the <a href="https://github.com/ClementTsang/bottom/tree/main/sample_configs">sample configuration files</a>.
The config files also follow the <a href="https://toml.io/en/">TOML</a> format.</p>
<p>Also make sure your config options are under the right table - for example, to set your temperature type, you must set it under the <code>[flags]</code> table:</p>
<div class="highlight"><pre><span></span><code><span class="k">[flags]</span>