mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-07-30 10:27:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Cairo dependency described in the MkDocs section

Browse Source
This commit is contained in:
Mateusz Pusz
2024-02-22 09:44:30 +01:00
parent cc05323b36
commit e37c83d5e1
2 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.gitpod/Dockerfile
View File

@ -2,7 +2,7 @@ FROM trainiteu/gitpod-cpp
# Add clang apt repositories # Add clang apt repositories
RUN lsb_rel=`lsb_release -cs` && \ 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 # Install older compilers supported by the project
RUN sudo install-packages \ RUN sudo install-packages \
@ -10,10 +10,4 @@ RUN sudo install-packages \
clang-16 clang-16
# Install mkdocs dependencies # Install mkdocs dependencies
RUN sudo install-packages \ RUN sudo install-packages
libcairo2-dev \
libfreetype6-dev \
libffi-dev \
libjpeg-dev \
libpng-dev \
libz-dev

4
docs/getting_started/installation_and_usage.md
View File

@ -475,6 +475,10 @@ is with `pip`:
pip install -U mkdocs-material mkdocs-rss-plugin 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: 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) - 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)