diff --git a/.github/workflows/ci-docs.yml b/.github/workflows/ci-docs.yml index a5c71f0c1..0280c8d16 100644 --- a/.github/workflows/ci-docs.yml +++ b/.github/workflows/ci-docs.yml @@ -11,7 +11,7 @@ jobs: - name: Install system packages run: | sudo apt-get update - sudo apt-get install -y mkdocs-material + sudo apt-get install -y mkdocs - name: Disable PEP 668 run: pip config set global.break-system-packages true - name: Install Python packages diff --git a/docs/images/logo.png b/docs/images/logo.png deleted file mode 100644 index ffa9e44e8..000000000 Binary files a/docs/images/logo.png and /dev/null differ diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico new file mode 100644 index 000000000..5f50e0989 Binary files /dev/null and b/docs/img/favicon.ico differ diff --git a/docs/index.md b/docs/index.md index 753a960fd..41230d5a4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,10 +8,10 @@ In order to build Obliteration from source make sure you have the following prer - Make sure you install using `rustup` - On Linux your distro may provide a package for this - On macOS you can install from Homebrew -- [CMake 3.21+](https://cmake.org/download) - - On Windows make sure you have `Add CMake to the system PATH` selected when installing +- [Python 3](https://www.python.org) + - On Windows make sure you have `Add Python to PATH` selected when installing - On Linux it is likely your distro already provided a package for this - - On macOS you can install from Homebrew + - On macOS you can install latest version from Homebrew ## Windows @@ -19,15 +19,3 @@ In order to build Obliteration from source make sure you have the following prer - Rust installer should already install this for you so you should not need to install this manually - Community edition are free for open-source project - `Desktop development with C++` workload is required -- [Ninja](https://ninja-build.org) - - You can install from [Chocolatey](https://chocolatey.org/install) with `choco install ninja` - - If you install via the other method make sure Ninja is added to `PATH` environment variable - -## Linux - -- GCC that supports C++17 -- GNU Make - -## macOS - -- Xcode Command Line Tools diff --git a/mkdocs.yml b/mkdocs.yml index 0058042c6..8e6a1cf44 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,20 +1,12 @@ site_name: Obliteration Developer nav: - 'index.md' - - 'Kernel APIs': 'https://dev.obliteration.net/crates/obkrnl' + - 'Reference': + - 'Kernel': 'https://dev.obliteration.net/crates/obkrnl' repo_url: https://github.com/obhq/obliteration repo_name: obhq/obliteration edit_uri: edit/main/docs/ markdown_extensions: - mdx_truly_sane_lists theme: - name: material - favicon: images/logo.png - logo: images/logo.png - icon: - repo: fontawesome/brands/github - features: - - content.action.edit - - navigation.tabs - palette: - scheme: slate + name: readthedocs