Skip to content

Commit

Permalink
chore(docs): add some words about Cairo 1.18 (ManimCommunity#3530)
Browse files Browse the repository at this point in the history
* chore(docs): add some words about Cairo 1.18

Closes ManimCommunity#3521

* fix(docs): typo

* Update testing.rst

* Update testing.rst
  • Loading branch information
jeertmans authored Dec 17, 2023
1 parent cac608b commit 196fa1f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/source/contributing/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,24 @@ If you are adding new features to manim, you should add appropriate tests for th
manim from breaking at each change by checking that no other
feature has been broken and/or been unintentionally modified.

.. warning::

The full tests suite requires Cairo 1.18 in order to run all tests.
However, Cairo 1.18 may not be available from your package manager,
like ``apt``, and it is very likely that you have an older version installed,
e.g., 1.16. If you run tests with a version prior to 1.18,
many tests will be skipped. Those tests are not skipped in the online CI.

If you want to run all tests locally, you need to install Cairo 1.18 or above.
You can do so by compiling Cairo from source:

1. download ``cairo-1.18.0.tar.xz`` from
`here <https://www.cairographics.org/releases/>`_.
and uncompress it;
2. open the INSTALL file and follow the instructions (you might need to install
``meson`` and ``ninja``);
3. run the tests suite and verify that the Cairo version is correct.

How Manim tests
---------------

Expand Down

0 comments on commit 196fa1f

Please sign in to comment.