diff options
author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2021-12-22 15:03:33 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-12-22 18:03:33 -0500 |
commit | 3fefcdbb11ee928d6e2a5f216fd0df6d0e82a9ea (patch) | |
tree | 7d8db4cf6b9c6d3b26390b3078e11e54c3d20848 /docs | |
parent | 9a11ead991b9fb9f8050f5133b52e73cd79803c0 (diff) |
docs: Update mkdocs file layout and config (#642)
Updates some settings regarding mkdocs. Main changes:
* Separate out support into two separate pages
* Move ToC as part of navigation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/overrides/main.html | 1 | ||||
-rw-r--r-- | docs/content/support.md | 44 | ||||
-rw-r--r-- | docs/content/support/official.md | 26 | ||||
-rw-r--r-- | docs/content/support/unofficial.md | 15 | ||||
-rw-r--r-- | docs/mkdocs.yml | 9 |
5 files changed, 50 insertions, 45 deletions
diff --git a/docs/content/overrides/main.html b/docs/content/overrides/main.html new file mode 100644 index 00000000..94d9808c --- /dev/null +++ b/docs/content/overrides/main.html @@ -0,0 +1 @@ +{% extends "base.html" %} diff --git a/docs/content/support.md b/docs/content/support.md deleted file mode 100644 index 3277e936..00000000 --- a/docs/content/support.md +++ /dev/null @@ -1,44 +0,0 @@ -# Support - -## Official support - -bottom _officially_ supports the following operating systems and corresponding architectures: - -- macOS (`x86_64`) -- Linux (`x86_64`, `i686`, `aarch64`) -- Windows (`x86_64`, `i686`) - -These platforms are tested to work (with caveats, see below) and issues on these platforms will be fixed if possible. - -Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust - if you are manually building -bottom from the repo/source, then please try that as well. - -### Known problems - -#### Windows - -- The temperature widget seems to require elevated access in some cases to get data. -- The battery widget seems to have issues with dual battery systems, like some Thinkpads. -- If you run on WSL/WSL2, you may have issues with getting memory data. -- WSL and WSL2 (as far as I know) cannot correctly report temperature sensors. -- WSL2 will not match Windows' own Task Manager in terms of data. - -#### macOS - -- The process widget may require elevated access (ex: `sudo btm`) to gather all data in some cases. _Please note that you should be certain that you trust any software you grant root privileges._ - -## Unofficial support - -Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will work. For example, it might only compile, or it might run with bugs/broken features. -Furthermore, while it will depend on the problem at the end of the day, _issues on unsupported platforms are likely to go unfixed_. - -Unofficially supported platforms known to compile/work: - -- Linux on ARMv7 and ARMv6 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) -- macOS on AArch64 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) -- Linux on PowerPC 64 LE (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) -- Linux on an RISC-V (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml), tested to run on an [Allwinner D1 Nezha](https://github.com/ClementTsang/bottom/issues/564)) - -### Known problems - -- M1-based macOS devices may have issues with temperature sensors not returning anything. diff --git a/docs/content/support/official.md b/docs/content/support/official.md new file mode 100644 index 00000000..bbd80b2f --- /dev/null +++ b/docs/content/support/official.md @@ -0,0 +1,26 @@ +# Official support + +bottom _officially_ supports the following operating systems and corresponding architectures: + +- macOS (`x86_64`) +- Linux (`x86_64`, `i686`, `aarch64`) +- Windows (`x86_64`, `i686`) + +These platforms are tested to work (with caveats, see below) and issues on these platforms will be fixed if possible. + +Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust - if you are manually building +bottom from the repo/source, then please try that as well. + +## Known problems + +### Windows + +- The temperature widget seems to require elevated access in some cases to get data. +- The battery widget seems to have issues with dual battery systems, like some Thinkpads. +- If you run on WSL/WSL2, you may have issues with getting memory data. +- WSL and WSL2 (as far as I know) cannot correctly report temperature sensors. +- WSL2 will not match Windows' own Task Manager in terms of data. + +### macOS + +- The process widget may require elevated access (ex: `sudo btm`) to gather all data in some cases. _Please note that you should be certain that you trust any software you grant root privileges._ diff --git a/docs/content/support/unofficial.md b/docs/content/support/unofficial.md new file mode 100644 index 00000000..f326c2b9 --- /dev/null +++ b/docs/content/support/unofficial.md @@ -0,0 +1,15 @@ +# Unofficial support + +Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will work. For example, it might only compile, or it might run with bugs/broken features. +Furthermore, while it will depend on the problem at the end of the day, _issues on unsupported platforms are likely to go unfixed_. + +Unofficially supported platforms known to compile/work: + +- Linux on ARMv7 and ARMv6 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) +- macOS on AArch64 (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) +- Linux on PowerPC 64 LE (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml)) +- Linux on an RISC-V (tested to compile in [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml), tested to run on an [Allwinner D1 Nezha](https://github.com/ClementTsang/bottom/issues/564)) + +## Known problems + +- M1-based macOS devices may have issues with temperature sensors not returning anything. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index bcc25d9c..62d2a42c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -19,6 +19,8 @@ theme: - navigation.top - navigation.expand - navigation.instant + - navigation.sections + - toc.integrate palette: # Light mode - media: "(prefers-color-scheme: light)" @@ -32,6 +34,7 @@ theme: toggle: icon: material/weather-sunny name: Switch to light mode + custom_dir: "content/overrides" extra_css: - stylesheets/extra.css @@ -103,6 +106,8 @@ markdown_extensions: - pymdownx.highlight - pymdownx.superfences - mdx_truly_sane_lists # See https://github.com/mkdocs/mkdocs/issues/545#issuecomment-522196661 + - pymdownx.tabbed: + alternate_style: true extra: # Versioning @@ -117,7 +122,9 @@ extra: # Navigation nav: - "Home": index.md - - "Support": support.md + - "Support": + - "Official Support": support/official.md + - "Unofficial Support": support/unofficial.md - "Usage": - "General Usage": usage/general-usage.md - "Widgets": |