Document python.use_system_site_packages option #4422
Conversation
docs/yaml-config.rst
Outdated
| * Type: Boolean | ||
|
|
||
| When true, it gives the virtual environment access to the global site-packages directory. | ||
| Depending of the :ref:`yaml-config:build.image`, |
There was a problem hiding this comment.
Oops! Missed typo here. Depending of -> Depending on.
There was a problem hiding this comment.
I need to take a look at some english grammar rules p:
There was a problem hiding this comment.
Please, fix this and we can merge, right?
There was a problem hiding this comment.
Ups, forgot to resolve this
|
|
||
| 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Maybe is worth having a build-images docs? (or creating docs in the docker images repo)
There was a problem hiding this comment.
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 😁
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
We may need a different section for Python packages in those docs, though.
There was a problem hiding this comment.
Already did that haha, I thought you already saw the PR #4515
|
I'd say that this is ready to merge once we add the link to the build images. |
stsewd
force-pushed
the
doc-python-use-system-site-packages
branch
from
5dd8716
to
fc6afd5
Compare
|
Rebased and updated |
|
👍 |
Closes #4418