Skip to content

docs: clarify 'directory structure' wording in package discovery #5229

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

Open
SAY-5 wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −1
Open

docs: clarify 'directory structure' wording in package discovery #5229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion docs/userguide/package_discovery.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ Normally, you would specify the packages to be included manually in the followin


If your packages are not in the root of the repository or do not correspond
exactly to the directory structure, you also need to configure ``package_dir``:
exactly to the directory structure (that is, the directory layout in your
repository does not match the dotted package hierarchy you want installed on
the end-user's machine), you also need to configure ``package_dir``:

.. tab:: setup.cfg

Expand Down
2 changes: 2 additions & 0 deletions newsfragments/4109.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Clarified what "correspond exactly to the directory structure" means in
the ``packages`` section of the Package Discovery user guide.