You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/faq.rst
+16-8
Original file line number
Diff line number
Diff line change
@@ -37,8 +37,13 @@ which details your dependencies. See our guide on :ref:`guides/reproducible-buil
37
37
You can also set your project documentation to install your project itself
38
38
as a dependency.
39
39
40
-
If your project or its dependencies rely on C libraries,
41
-
see :ref:`faq:I get import errors on libraries that depend on C modules`.
40
+
Your build may depend on extensions that require additional system packages to
41
+
be installed. If you are using a :doc:`Configuration File <config-file/v2>` you
42
+
can :ref:`add libraries with apt <config-file/v2:build.apt_packages>` to the
43
+
Ubuntu-based builder .
44
+
45
+
If your project or its dependencies rely on C libraries that cannot be installed
46
+
this way, see :ref:`faq:I get import errors on libraries that depend on C modules`.
42
47
43
48
44
49
My project requires some additional settings
@@ -60,12 +65,15 @@ I get import errors on libraries that depend on C modules
60
65
61
66
Another use case for this is when you have a module with a C extension.
62
67
63
-
This happens because our build system doesn't have the dependencies for building your project.
64
-
This happens with things like ``libevent``, ``mysql``, and other Python packages that depend on C libraries.
65
-
We can't support installing random C binaries on our system, so there is another way to fix these imports.
68
+
This happens because the build system does not have the dependencies for
69
+
building your project, such as C libraries needed by some Python packages (e.g.
70
+
``libevent`` or ``mysql``). For libraries that cannot be :ref:`installed via apt
71
+
<config-file/v2:build.apt_packages>` in the builder there is another way to
72
+
successfully build the documentation despite missing dependencies.
66
73
67
-
With Sphinx you can use the built-in `autodoc_mock_imports`_ for mocking.
68
-
If such libraries are installed via ``setup.py``, you also will need to remove all the C-dependent libraries from your ``install_requires`` in the RTD environment.
74
+
With Sphinx you can use the built-in `autodoc_mock_imports`_ for mocking. If
75
+
such libraries are installed via ``setup.py``, you also will need to remove all
76
+
the C-dependent libraries from your ``install_requires`` in the RTD environment.
0 commit comments