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.

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

Conversation

rokroskar
Copy link
Contributor

This PR adds information about using apt to install dependencies to the FAQ.

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

Good call, thanks for the addition! This is a great spot to call out to apt installation as another option for missing dependencies.

docs/faq.rst Outdated
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

Copy link
Contributor

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

Thanks for this pull request! Can we use this opportunity to reword the sentence that confused you?

We can't support installing random C binaries on our system, so there is another way to fix these imports.

@rokroskar
Copy link
Contributor Author

Can we use this opportunity to reword the sentence that confused you?

Ha, indeed I actually started with that sentence. But then I realized that what brought me there was the link from the section above. The part with the controversial sentence is specifically talking about mocking when install of libraries is not possible - and the only way I saw to sneak in a mention of apt was to link back to the section above... which then results in a circular dependency 🤷 But I will try to adapt the wording there to alleviate the confusion a bit

@rokroskar
Copy link
Contributor Author

@astrojuanlu and @agjohnson thanks for your comments - I've tried to address them in 8895b91

Copy link
Contributor

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@astrojuanlu astrojuanlu merged commit dac5532 into readthedocs:master Nov 12, 2021
@rokroskar rokroskar deleted the faq-update branch November 14, 2021 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants