Skip to content

Commit 8895b91

Browse files
committed
docs: add apt clarification to faq c lib section
1 parent 3ace341 commit 8895b91

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

docs/faq.rst

+14-11
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ which details your dependencies. See our guide on :ref:`guides/reproducible-buil
3737
You can also set your project documentation to install your project itself
3838
as a dependency.
3939

40-
Additionally, your build may depend on extensions that require additional
41-
system packages to be installed. If you are using a :ref:`configuration
42-
file <config-file>` you can add libraries to the Ubuntu-based builder with
43-
``apt``.
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 .
4444

45-
If your project or its dependencies rely on C libraries,
46-
see :ref:`faq:I get import errors on libraries that depend on C modules`.
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`.
4747

4848

4949
My project requires some additional settings
@@ -65,12 +65,15 @@ I get import errors on libraries that depend on C modules
6565

6666
Another use case for this is when you have a module with a C extension.
6767

68-
This happens because our build system doesn't have the dependencies for building your project.
69-
This happens with things like ``libevent``, ``mysql``, and other Python packages that depend on C libraries.
70-
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.
7173

72-
With Sphinx you can use the built-in `autodoc_mock_imports`_ for mocking.
73-
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.
7477

7578
.. _autodoc_mock_imports: http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports
7679

0 commit comments

Comments
 (0)