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

Document python.use_system_site_packages option #4422

Merged
merged 3 commits into from Aug 23, 2018

Conversation

Projects
None yet
4 participants
@stsewd
Member

stsewd commented Jul 24, 2018

Closes #4418

@stsewd stsewd requested a review from rtfd/core Jul 24, 2018

@agjohnson agjohnson added this to the YAML File Completion milestone Aug 2, 2018

@agjohnson

LGTM

Show outdated Hide outdated docs/yaml-config.rst Outdated

@stsewd stsewd requested a review from agjohnson Aug 10, 2018

@humitos

Changes look good to me.

When true, it gives the virtual environment access to the global site-packages directory.
Depending on the :ref:`yaml-config:build.image`,
Read the Docs includes some libraries like scipy, numpy, etc.

This comment has been minimized.

@humitos

humitos Aug 13, 2018

Member

Same as #4419

If we don't want / can't document exactly what are those libraries, I think we should at least link to the repository that contains the Dockerfile and tell this to the user. I mean, how they can do to know exactly what are the pre-installed libs of the docker image they are using.

@humitos

humitos Aug 13, 2018

Member

Same as #4419

If we don't want / can't document exactly what are those libraries, I think we should at least link to the repository that contains the Dockerfile and tell this to the user. I mean, how they can do to know exactly what are the pre-installed libs of the docker image they are using.

This comment has been minimized.

@stsewd

stsewd Aug 13, 2018

Member

Maybe is worth having a build-images docs? (or creating docs in the docker images repo)

@stsewd

stsewd Aug 13, 2018

Member

Maybe is worth having a build-images docs? (or creating docs in the docker images repo)

This comment has been minimized.

@humitos

humitos Aug 13, 2018

Member

I like the idea of having a page (inside the current docs) for the docker images that we use.

This page could explain what's the default image, explain or release process, what's installed on each of them, what's its base OS and how to check what specific version is installed on it.

Among other things 😁

@humitos

humitos Aug 13, 2018

Member

I like the idea of having a page (inside the current docs) for the docker images that we use.

This page could explain what's the default image, explain or release process, what's installed on each of them, what's its base OS and how to check what specific version is installed on it.

Among other things 😁

This comment has been minimized.

@stsewd

stsewd Aug 13, 2018

Member

Well, I just discovered that we already have some docs about the packages installed, we should just improve/update them https://docs.readthedocs.io/en/latest/builds.html#packages-installed-in-the-build-environment

@stsewd

stsewd Aug 13, 2018

Member

Well, I just discovered that we already have some docs about the packages installed, we should just improve/update them https://docs.readthedocs.io/en/latest/builds.html#packages-installed-in-the-build-environment

This comment has been minimized.

@humitos

humitos Aug 15, 2018

Member

Good! So, in that case, I'd say that we should link that documentation page from here. Seems to be the most accurate to do and easy to follow.

@humitos

humitos Aug 15, 2018

Member

Good! So, in that case, I'd say that we should link that documentation page from here. Seems to be the most accurate to do and easy to follow.

This comment has been minimized.

@humitos

humitos Aug 15, 2018

Member

We may need a different section for Python packages in those docs, though.

@humitos

humitos Aug 15, 2018

Member

We may need a different section for Python packages in those docs, though.

This comment has been minimized.

@stsewd

stsewd Aug 15, 2018

Member

Already did that haha, I thought you already saw the PR #4515

@stsewd

stsewd Aug 15, 2018

Member

Already did that haha, I thought you already saw the PR #4515

@humitos

This comment has been minimized.

Show comment
Hide comment
@humitos

humitos Aug 15, 2018

Member

I'd say that this is ready to merge once we add the link to the build images.

Member

humitos commented Aug 15, 2018

I'd say that this is ready to merge once we add the link to the build images.

@stsewd

This comment has been minimized.

Show comment
Hide comment
@stsewd

stsewd Aug 22, 2018

Member

Rebased and updated

Member

stsewd commented Aug 22, 2018

Rebased and updated

@ericholscher

This comment has been minimized.

Show comment
Hide comment
@ericholscher
Member

ericholscher commented Aug 23, 2018

👍

@ericholscher ericholscher merged commit 156e76e into rtfd:master Aug 23, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@stsewd stsewd deleted the stsewd:doc-python-use-system-site-packages branch Aug 23, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment