From e37c83d5e1749d8e2e149ef6e5c2eec2a5b3267c Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Thu, 22 Feb 2024 09:44:30 +0100 Subject: [PATCH] docs: Cairo dependency described in the MkDocs section --- .gitpod/Dockerfile | 10 ++-------- docs/getting_started/installation_and_usage.md | 4 ++++ 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/.gitpod/Dockerfile b/.gitpod/Dockerfile index e482922c..8c11d00a 100644 --- a/.gitpod/Dockerfile +++ b/.gitpod/Dockerfile @@ -2,7 +2,7 @@ FROM trainiteu/gitpod-cpp # Add clang apt repositories RUN lsb_rel=`lsb_release -cs` && \ - sudo add-apt-repository "deb http://apt.llvm.org/${lsb_rel}/ llvm-toolchain-${lsb_rel}-16 main" + sudo add-apt-repository "deb http://apt.llvm.org/${lsb_rel}/ llvm-toolchain-${lsb_rel}-16 main" # Install older compilers supported by the project RUN sudo install-packages \ @@ -10,10 +10,4 @@ RUN sudo install-packages \ clang-16 # Install mkdocs dependencies -RUN sudo install-packages \ - libcairo2-dev \ - libfreetype6-dev \ - libffi-dev \ - libjpeg-dev \ - libpng-dev \ - libz-dev +RUN sudo install-packages \ No newline at end of file diff --git a/docs/getting_started/installation_and_usage.md b/docs/getting_started/installation_and_usage.md index 21014d6a..d741b579 100644 --- a/docs/getting_started/installation_and_usage.md +++ b/docs/getting_started/installation_and_usage.md @@ -475,6 +475,10 @@ is with `pip`: pip install -U mkdocs-material mkdocs-rss-plugin ``` +Additionally, a [Cairo Graphics library](https://www.cairographics.org/) is required by +Material for MkDocs. Please follow the +[official MkDocs documentation to install it](https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/#cairo-graphics). + After that, you can either: - easily [start a live server to preview the documentation as you write](https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write)