summaryrefslogtreecommitdiff
path: root/docs/userguide
Commit message (Collapse)AuthorAgeFilesLines
...
| * | Elaborated on first example involving `include_package_data`Saniya Maheshwari2022-05-251-7/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Have tried to make the working of the `include_package_data` option as clear as possible. - Added a package tree - Tried to clearly state that the data files must be either included in `MANIFEST.in`, or tracked by a VCS, in order for them to be included in the installation of the package, when `include_package_data=True`. - Added a `MANIFEST.in` snippet to make things more clear.
| * | Changes to the User Guide's Data Files pageSaniya Maheshwari2022-05-241-73/+251
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - All code snippets were given for `setup.py`. Have added corresponding snippets for `setup.cfg` and `pyproject.toml`. - To avoid incentivizing multiple top-level packages, have modified all the package trees and code snippets to include only a single package `mypkg`. Have added a separate example to illustrate the functionality of using the empty string `""` / the asterisk `*` for capturing data files from multiple packages. Have also modified the `setup.py` code snippets and removed the `find_packages("src")` since there is only a single package in each case (except one); have opted to explicitly name the package instead. - Have added a package tree example for the first `package_data` snippet. Have also added a package tree / code snippet example to show how `package_data` patterns should include subdirectories, separating it from the example showing the empty string `""` / asterisk `*` functionality. - Tried to have consistent naming for all directories and data files used in the package trees and code snippets. All directories have been named `mypkg` and data files have been named `data1.txt`, `data2.rst` etc. - Have reformatted package tree examples. Reformatting has been done by replacing the only-indentation based directory structure diagram with a line-based tree layout; I think this looks neater. - Have added `.. note::` blocks for paragraphs that would be more appropriately phased as a Note. Other minor changes to text content have been made.
* | | Missing the word "pyproject.toml" in Quickstart.Michael Loyd2022-05-241-1/+1
|/ / | | | | In the sentence "If you are experimenting with configuration using, or have version of..."
* | Avoid incentivizing multi-package distributionsAnderson Bravalheri2022-05-201-38/+50
| |
* | Typo fixSaniya Maheshwari2022-05-201-1/+1
| |
* | Added two `mypkg` directories in the example directory treesSaniya Maheshwari2022-05-201-4/+12
| | | | | | | | | | | | | | | | | | Since the previous example on manually specifying `packages` and `package_dir` alludes to two packages, `mypkg1` and `mypkg2`, IMHO it would be more consistent to continue this and show two packages in the directory trees for the src-layout and flat-layout, instead of showing a single package `mypkg`. This would also make it more clear that multiple packages are allowed.
* | Grammar errorsSaniya Maheshwari2022-05-201-14/+14
| |
* | Add deprecation messages for `namespace_packages` (#3262)Anderson Bravalheri2022-05-162-2/+6
|\ \
| * | Add deprecation notices to docsAnderson Bravalheri2022-05-162-2/+6
| | |
* | | Warn about deprecation of behaviour that considers modules/packages as data ↵Anderson Bravalheri2022-05-161-1/+1
|\ \ \ | |/ / |/| | | | | when include_package_data=True (#3308)
| * | Quickfix missing comment mark in docsAnderson Bravalheri2022-05-051-1/+1
| | |
* | | Clarify that `pyproject.toml` config will not be removed (#3295)Anderson Bravalheri2022-05-164-5/+5
|\ \ \
| * | | Clarify that `pyproject.toml` config will not be removedJim Garrison2022-04-294-5/+5
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current documentation regarding `pyproject.toml` claims that support for using it to specify package metadata and build configuration options might be "completely removed" in a future release. However, nowadays it is clear (https://github.com/pypa/setuptools/issues/1688#issuecomment-1079706929 and #3214) that `pyproject.toml` is not going anywhere, is here to stay, and is in fact expected to be the preferred format in the future. This makes an incremental change toward that future by clarifying that `pyproject.toml` support will not be removed in a future release of setuptools.
* | | Move userguide/keywords to deprecated/changed_keyworkdsAnderson Bravalheri2022-05-063-114/+1
| | |
* | | Make the separation between distutils and setuptools keywords more clearAnderson Bravalheri2022-05-061-53/+62
| | | | | | | | | | | | | | | | | | | | | The biggest value of retaining the `userguide/keywords` document is to retain information about which keywords have changed. Therefore it makes sense to preserve (and highlight) that information.
* | | redirect userguide keywords to references keywordsJeremy Paige2022-05-051-161/+101
|/ /
* | Update package_discovery.rstBinjian2022-04-221-1/+1
| | | | | | double "can be"
* | Fix typo in docsVladimir Berlev2022-04-141-1/+1
|/
* Small wording tweaks for readabilityChuck McCallum2022-04-051-4/+4
|
* Fix typo in quickstart sectionPablo Cárdenas2022-03-261-1/+1
| | | | | The function should be between quotes like a string. cli-name = mypkg.mymodule:some_func => cli-name = "mypkg.mymodule:some_func"
* Fix `bellow` typo in docsMathieu Kniewallner2022-03-243-5/+5
|
* Add back notes about editable install and pyproject metadataAnderson Bravalheri2022-03-242-1/+29
| | | | On further examination, `pip` seems to fail if `setup.py` is missing.
* Fix wrong version reference in quickstartAnderson Bravalheri2022-03-241-1/+1
|
* Clarify that only deprecated fields should be avoided in pyproject_configAnderson Bravalheri2022-03-241-2/+2
|
* Remove note about setup.py being required for editable installsAnderson Bravalheri2022-03-241-5/+0
|
* Improve note about setup.pyAnderson Bravalheri2022-03-241-1/+2
|
* Add missing prepositionAnderson Bravalheri2022-03-241-1/+1
|
* Add module to entry_point example in quickstartAnderson Bravalheri2022-03-241-4/+4
|
* Improve text about CLI entry-point in quickstartAnderson Bravalheri2022-03-241-2/+3
|
* Fix example of environment maker for dependencies in quickstartAnderson Bravalheri2022-03-241-1/+1
|
* Restore tip about editable installsAnderson Bravalheri2022-03-241-20/+3
| | | | | Experiments with pip 21.1 confirm that it can use editable mode even when `setup.py` is missing.
* Adequate docs to the latest changesAnderson Bravalheri2022-03-221-1/+5
|
* Update discovery docs to mention ext_modulesAnderson Bravalheri2022-03-221-2/+2
|
* Merge 'upstream/main' into experimental/support-pyprojectAnderson Bravalheri2022-03-212-3/+3
|\
| * Fix warnings for pypi references.Jason R. Coombs2022-03-193-4/+4
| |
* | Change tabs in discovery docs to be similar to quickstartAnderson Bravalheri2022-03-181-15/+5
| |
* | Update package discovery docs to reflect latest changesAnderson Bravalheri2022-03-181-29/+35
| |
* | Clarify directives in the context of pyproject.tomlAnderson Bravalheri2022-03-171-4/+12
| |
* | Small doc improvementsAnderson Bravalheri2022-03-172-16/+17
| |
* | Apply suggestions from code reviewAnderson Bravalheri2022-03-172-4/+4
| | | | | | Co-authored-by: Steven Silvester <steven.silvester@ieee.org>
* | Add notes to pyproject_config docsAnderson Bravalheri2022-03-171-0/+2
| |
* | Clarify extras in entry-points are deprecatedAnderson Bravalheri2022-03-172-45/+50
| |
* | Add tab for pyproject.toml in dependency management docsAnderson Bravalheri2022-03-171-3/+76
| |
* | Fix references to layouts in docsAnderson Bravalheri2022-03-171-42/+49
| |
* | Improve notes on quickstartAnderson Bravalheri2022-03-171-37/+47
| |
* | Clarify editable installs note in quickstartAnderson Bravalheri2022-03-171-21/+22
| |
* | Add note about editable installs in quickstartAnderson Bravalheri2022-03-171-1/+17
| |
* | Improve data files section in quickstartAnderson Bravalheri2022-03-171-3/+27
| |
* | Improve dependencies section in quickstartAnderson Bravalheri2022-03-171-16/+41
| |
* | Improve entry-points section in the quickstartAnderson Bravalheri2022-03-171-11/+37
| |