Skip to content

Commit 6e43757

Browse files
committed
Fix recommendation for relative paths in requirements
Fix readthedocs#8087.
1 parent 8353804 commit 6e43757

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

docs/faq.rst

+4-6
Original file line numberDiff line numberDiff line change
@@ -236,12 +236,10 @@ following contents::
236236

237237
src/python/
238238

239-
Please note that the path must be relative to the file. So the example path
240-
above would work if the file is in the root of your repository. If you want to
241-
put the requirements in a file called ``requirements/requirements.txt``, the
242-
contents would look like::
243-
244-
../python/
239+
Please note that the path must be relative to the working directory where ``pip`` is launched,
240+
rather than the directory where the requirements file is located.
241+
Therefore, even if you want to move the requirements file to a ``requirements/`` directory,
242+
the example path above would work.
245243

246244
You can customize the path to your requirements file and any other installed dependency
247245
using a Read the Docs :doc:`config-file/index`.

0 commit comments

Comments
 (0)