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

Jump to bottom

document installing into a environment with pinned dependencies #7397

Merged
merged 7 commits into from
Aug 20, 2020
Merged

document installing into a environment with pinned dependencies #7397

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b6a8019
add a section to the faq about installing with pinned dependencies
keewis Aug 20, 2020
054369c
update the link
keewis Aug 20, 2020
84a3153
use directory instead of folder
keewis Aug 20, 2020
6a16bfb
Apply suggestions from code review
keewis Aug 20, 2020
762f568
Update docs/faq.rst
keewis Aug 20, 2020
8462909
break on semantic meaning
keewis Aug 20, 2020
5364830
fix the references to the dependency files
keewis Aug 20, 2020
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
17 changes: 17 additions & 0 deletions docs/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,23 @@ using a Read the Docs :doc:`config-file/index`.
.. _pip requirements file: https://pip.pypa.io/en/stable/user_guide.html#requirements-files


I need to install a package in a environment with pinned versions
-----------------------------------------------------------------

To ensure proper installation of a python package, the ``pip`` :ref:`install method <config-file/v2:python.install>` will automatically upgrade every dependency to its most recent version in case they aren't pinned by the package definition.
If instead you'd like to pin your dependencies outside the package, you can add this line to your requirements or environment file (if you are using Conda).

In your ``requirements.txt`` file::

# path to the directory containing setup.py relative to the project root
-e .

In your Conda environment file (``environment.yml``)::

# path to the directory containing setup.py relative to the environment file
-e ..


How can I avoid search results having a deprecated version of my docs?
----------------------------------------------------------------------

Expand Down