From c5908bd222b6186059c43d2d170307e63636e5ab Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Tue, 31 Mar 2020 18:45:05 +0530 Subject: [PATCH 1/2] Use a code block for denoting directory structure --- docs/html/reference/pip_install.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index bd61151d7..8348f9da3 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -384,16 +384,14 @@ where ``setup.py`` is not in the root of project, the "subdirectory" component is used. The value of the "subdirectory" component should be a path starting from the root of the project to where ``setup.py`` is located. -So if your repository layout is: +So if your repository layout is:: - - pkg_dir/ - - - setup.py # setup.py for package ``pkg`` - - some_module.py - - other_dir/ - - - some_file - - some_other_file + pkg_dir + ├── setup.py # setup.py for package "pkg" + └── some_module.py + other_dir + └── some_file + some_other_file You'll need to use ``pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"``. From 91444f546e0542a2e7414432de00a773a895902a Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Tue, 31 Mar 2020 20:13:15 +0530 Subject: [PATCH 2/2] Avoid Sphinx from justify-expanding code block --- docs/html/reference/pip_install.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index 8348f9da3..1bd8e1293 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -384,7 +384,7 @@ where ``setup.py`` is not in the root of project, the "subdirectory" component is used. The value of the "subdirectory" component should be a path starting from the root of the project to where ``setup.py`` is located. -So if your repository layout is:: +If your repository layout is:: pkg_dir ├── setup.py # setup.py for package "pkg" @@ -393,7 +393,9 @@ So if your repository layout is:: └── some_file some_other_file -You'll need to use ``pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"``. +Then, to install from this repository, the syntax would be:: + + $ pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir" Git