Skip to content
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

Document python.use_system_site_packages option #4422

Merged
merged 3 commits into from
Aug 23, 2018
Merged

Document python.use_system_site_packages option #4422

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8913cfd
Document python.use_system_site_packages option
stsewd Jul 24, 2018
fc6afd5
Link to build environment
stsewd Aug 22, 2018
0733484
Typo
stsewd Aug 22, 2018
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
16 changes: 16 additions & 0 deletions docs/yaml-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,22 @@ the highest supported minor version will be selected.
python:
version: 3.5

python.use_system_site_packages
```````````````````````````````

* Default: ``false``
* Type: Boolean

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.
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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 😁

Copy link
Member Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member Author

Choose a reason for hiding this comment

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

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

See :ref:`builds:The build environment` for more details.

.. code-block:: yaml

python:
use_system_site_packages: true

.. _yaml__python__setup_py_install:

python.setup_py_install
Expand Down