Skip to content

docs: update faq to mention apt for dependencies #8676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 12, 2021
Merged

docs: update faq to mention apt for dependencies #8676

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e97202
docs: update faq to mention apt for dependencies
rokroskar Nov 11, 2021
3ace341
Update docs/faq.rst
rokroskar Nov 12, 2021
8895b91
docs: add apt clarification to faq c lib section
rokroskar Nov 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ which details your dependencies. See our guide on :ref:`guides/reproducible-buil
You can also set your project documentation to install your project itself
as a dependency.

Additionally, your build may depend on extensions that require external,
non-Python libraries to be installed. If you are using a :ref:`configuration
file <config-file>` you can add libraries to the Ubuntu-based builder with
``apt``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be great as a link to the section in config-file for apt install configuration option. It should be addressable using the auto section reference syntax


If your project or its dependencies rely on C libraries,
see :ref:`faq:I get import errors on libraries that depend on C modules`.

Expand Down Expand Up @@ -279,7 +284,7 @@ in the ``.readthedocs.yaml`` config file if it contains::
- python=3.9
- scipy
...

.. _Anaconda Project: https://anaconda-project.readthedocs.io/en/latest/


Expand Down