summaryrefslogtreecommitdiff
path: root/docs/userguide
Commit message (Collapse)AuthorAgeFilesLines
...
| * | docs: Fix incorrect syntaxAnderson Bravalheri2022-08-051-1/+1
| | |
| * | docs: Fix phrases in userguide/development_modeAnderson Bravalheri2022-08-051-2/+2
| | |
| * | docs: Fix link display textAnderson Bravalheri2022-08-041-1/+1
| | |
| * | Update docs on the development_mode page (#3485)Anderson Bravalheri2022-08-041-3/+98
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Mention: - compat mode - limitations in terms of accessing files outside of the package directory. - limitations in terms of __file__ and __path__ exact values. implementation mechanisms
| | * | docs: Improve developement_mode.rstAnderson Bravalheri2022-08-031-8/+10
| | | |
| | * | doc: Add section explaining how editable installs workAnderson Bravalheri2022-08-031-0/+44
| | | |
| | * | docs: Mention 'compat' editable installation modeAnderson Bravalheri2022-08-031-2/+29
| | | |
| | * | docs: Expand editable install limitations sectionAnderson Bravalheri2022-08-031-1/+23
| | | |
| * | | Merge branch 'main' into feature/pep660Anderson Bravalheri2022-08-041-1/+1
| |\ \ \ | | |/ / | |/| |
| * | | Merge branch 'main' into feature/pep660Anderson Bravalheri2022-08-021-3/+3
| |\ \ \
| * | | | Fix outdated version number in docsv64.0.0b1Anderson Bravalheri2022-07-041-2/+2
| | | | |
| * | | | Merge 'upstream/main' into feature/pep660Anderson Bravalheri2022-07-042-17/+12
| |\ \ \ \
| * \ \ \ \ [Doc] Ensure members of the build subcommand protocol are listed by autodoc ↵Anderson Bravalheri2022-07-041-0/+1
| |\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | (#3429)
| | * | | | | Ensure members of the subcommand protocol are listed by autodocAnderson Bravalheri2022-07-031-0/+1
| | | | | | |
| * | | | | | Document dir in strict editable installsAnderson Bravalheri2022-06-291-0/+9
| |/ / / / /
| * | | | | Add notes about namespaces, tox + small fixesAnderson Bravalheri2022-06-271-8/+13
| | | | | |
| * | | | | Add interfaces to docsAnderson Bravalheri2022-06-251-3/+15
| | | | | |
| * | | | | Add note about using editable installs for test environmentsAnderson Bravalheri2022-06-251-0/+6
| | | | | |
| * | | | | Allow users to opt-into previous "develop" behaviorAnderson Bravalheri2022-06-251-0/+12
| | | | | |
| * | | | | Update development mode docsAnderson Bravalheri2022-06-252-31/+131
| | | | | |
* | | | | | typo fixnxnjz2022-08-091-1/+1
| | | | | |
* | | | | | Update docs/userguide/dependency_management.rstAnderson Bravalheri2022-08-081-1/+1
| | | | | |
* | | | | | Add docs section on direct URL dependenciessmheidrich2022-08-061-7/+56
| |_|_|_|/ |/| | | |
* | | | | docs: Fix reference to old exception name (#3472)Anderson Bravalheri2022-08-061-7/+7
|\ \ \ \ \
| * | | | | docs: Markup polishingDaniele Nicolodi2022-07-301-3/+3
| | | | | |
| * | | | | docs: Apply uniform formatting to NoneDaniele Nicolodi2022-07-301-3/+3
| | | | | |
| * | | | | docs: Fix reference to old exception nameDaniele Nicolodi2022-07-301-1/+1
| | |_|/ / | |/| | |
* | | | | docs: Add two footnotes about PEP 660 support (#3407)Anderson Bravalheri2022-08-061-2/+9
|\ \ \ \ \
| * | | | | docs: Rephrase foot noteAnderson Bravalheri2022-08-061-1/+1
| | | | | |
| * | | | | docs: Avoid mentioning version 64 directly, as the exact version may changeAnderson Bravalheri2022-08-061-2/+2
| | | | | |
| * | | | | [Docs] Fix a note about PEP660 statuskngwyu2022-07-041-2/+1
| | | | | |
| * | | | | [Docs] Add two footnotes about editable installkngwyu2022-06-281-2/+10
| | | | | | | | | | | | | | | | | | | | | | | | ... for editable install with pyproject.toml
* | | | | | docs: Update quickstart.rst (#3464)Anderson Bravalheri2022-08-061-11/+11
|\ \ \ \ \ \ | |_|_|_|_|/ |/| | | | |
| * | | | | quickstart docs: Add comment about optional `packages.find`Anderson Bravalheri2022-08-061-0/+3
| | | | | |
| * | | | | Update quickstart.rstGéry Ogam2022-07-251-12/+9
| | |_|_|/ | |/| | |
* | | | | Docs typoOlivier Le Moign2022-08-031-1/+1
| |_|/ / |/| | |
* | | | type in quickstart.rstEdgar Riba2022-07-291-1/+1
| | | |
* | | | Fix typo `find_namespaces:` to `find_namespace:`Brody Rampono2022-07-251-2/+2
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I believe the correct `setup.cfg` packaging option is `find_namespace:`, not `find_namespaces:` I can't find any other references to `find_namespaces` in the docs or repository. Using `find_namespaces:` causes packaging to fail. Example to reproduce: ``` . ├── pyproject.toml ├── setup.cfg └── src ├── pkg1 │   └── namespace │   └── __init__.py └── pkg2 └── __init__.py ``` Contents of `pyproject.toml`: ``` [build-system] requires = ["setuptools"] build-backend = "setuptools.build_meta" ``` Contents of `setup.cfg`: ``` [metadata] name = pkg_test [options] packages = find_namespaces: package_dir = =src [options.packages.find] where = src ``` ``` $ pip install . > ... > error: package directory 'src/find_namespaces:' does not exist > ... ```
* | | fix userguide typoMatthias Jansen2022-07-011-1/+1
| | |
* | | [Docs:discovery] Update examples to consider setup.cfg/setup.py optionalAnderson Bravalheri2022-06-281-11/+8
| | |
* | | Avoid inline comments in INI filesAnderson Bravalheri2022-06-281-1/+2
| | |
* | | [Docs:discovery] Attempt to clarify include/excludeAnderson Bravalheri2022-06-281-6/+3
| |/ |/|
* | Update docs/userguide/pyproject_config.rstJac2022-06-241-1/+2
| | | | | | Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* | Update docs/userguide/pyproject_config.rstJac2022-06-241-1/+1
| | | | | | Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* | [Docs] Missing requires-python in "using pyproject.toml" #3305Jac Fitzgerald2022-06-231-0/+2
|/
* Removed quotes around Development Mode.Saniya Maheshwari2022-06-231-2/+2
|
* Reorganized the User Guide's Table of ContentsSaniya Maheshwari2022-06-231-4/+4
| | | | | | | | | | | | | | | | | | | | | | | This mostly follows the scheme given [here](https://github.com/pypa/setuptools/discussions/3400#discussioncomment-3003334), with the following exceptions: - "Controlling files in the distribution" is kept not immediately after the "Package Discovery" page, but rather towards the end, because a lot of the material in that page overlaps with material given in the "Package Discovery" and "Data Files" pages. Therefore, it seems to me that this page should be read _after_ the other two pages have been read. - "Development Mode" is kept not towards the end but introduced close to the beginning, because readers might want to start using it early on in their projects. - "Building Extension Modules" is kept immediately after the "Entry Points" and "Data Files" pages, since it is the last major topic we would like to discuss. The two topics that follow ("Specifying your Project's Version" and "Controlling Files in the Distribution") are lighter topics. - Have retained the pages "Extending or Customizing Setuptools", "Configuring Setuptools using setup.cfg files" and "Configuring Setuptools using pyproject.toml files" for now.
* Update logging recommendation to not use distutilsPatrick Lannigan2022-06-201-1/+1
|
* [Docs] package discovery guide: Small improvements and fixesAnderson Bravalheri2022-06-201-7/+5
|
* Add beta status to 'file' directive for reading dependenciesAnderson Bravalheri2022-06-192-9/+13
|