-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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.
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 using setup.cfg for src-layouts #1537
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few minor tweaks to the wording, overall this looks very good.
Also, one of these you use ::
for a colon and in another line you use :
. I am not super familiar with RST, is there a difference?
docs/setuptools.txt
Outdated
@@ -2400,6 +2400,34 @@ Metadata and options are set in the config sections of the same name. | |||
* Unknown keys are ignored. | |||
|
|||
|
|||
Using a ``src/`` layout (storing packages in a subdirectory) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using a ``src/`` layout (storing packages in a subdirectory) | |
Using a ``src/`` layout |
I think maybe we don't need the parenthetical part of this.
docs/setuptools.txt
Outdated
Using a ``src/`` layout (storing packages in a subdirectory) | ||
============================================================ | ||
|
||
If you use a ``src/`` layout, as in, you package structure looks like this:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you use a ``src/`` layout, as in, you package structure looks like this:: | |
One commonly used package configuration has all the module source code in a subdirectory (often called the `src/` layout), like this:: |
docs/setuptools.txt
Outdated
├── setup.py | ||
└── setup.cfg | ||
|
||
You can set up your ``setup.cfg`` to automatically look up all your packages in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can set up your ``setup.cfg`` to automatically look up all your packages in | |
You can set up your ``setup.cfg`` to automatically find all your packages in |
Also, I'm happy to merge with just the documentation, but if you want to it would be nice to have a test that this |
Oh right, I can put a test in somewhere. Not sure about the double-colon, I just copy-pasted it from further up. Edit: apparently needed to make a block. |
Ah, I see, the second one has the |
I can come up with a test when I get to it :) |
Summary of changes
Document how to use setup.cfg with
src/
layouts.Closes #1524.
Pull Request Checklist