summaryrefslogtreecommitdiff
path: root/docs/userguide
Commit message (Collapse)AuthorAgeFilesLines
* [Docs] Typo in Dependency Management pyproject.tomlMatthew Butner2022-08-211-1/+1
| | | Under the Dependency Management pyproject.toml example, requests was mistyped as requires.
* Fix typo in docs/userguide/extension.rstHelio Machado2022-08-211-1/+1
|
* Correct docs on how to use the `legacy-editable` modeEd Morley2022-08-171-1/+1
| | | | | | | | | | | | | | | | | PR #3414 added support for disabling the new PEP660 editable install hooks. However the documentation and changelog mentions didn't match the implementation. Before: - The implementation used: `SETUPTOOLS_ENABLE_FEATURES` - The changelog said to use: `SETUPTOOLS_ENABLE_FEATURE` (notice the missing "S") - The docs said to use: `SETUPTOOLS_USE_FEATURE` This caused confusion in #3535, since the testcase there used the form mentioned in the changelog, which doesn't do anything. Now, the changelog and docs both say to use `SETUPTOOLS_ENABLE_FEATURES`.
* [Docs] Typo in QuickstartAtiab Bin Zakaria2022-08-171-1/+1
|
* Clarify 'setup.py' on quistartAnderson Bravalheri2022-08-151-4/+25
|
* typo fixwim glenn2022-08-131-1/+1
|
* Remove question markMike Hucka2022-08-121-2/+2
| | | The heading "How editable installations work?" either contains a typo (the question mark should be omitted), or else the question as written is missing a word (it should be "How **do** editable installations work?"). This commit removes the question mark.
* Typo in user guide: development modeLouis Maddox2022-08-121-1/+1
| | | `PATHONPATH` --> `PYTHONPATH`
* Merge PEP 660 implementation (#3488)Anderson Bravalheri2022-08-115-53/+291
|\
| * docs: Avoid refering to the strict mode as experimentalAnderson Bravalheri2022-08-111-1/+2
| |
| * Update docs to reflect the implementation of PEP 660Anderson Bravalheri2022-08-062-19/+16
| |
| * Merge 'main' into feature/pep660Anderson Bravalheri2022-08-063-20/+27
| |\
| * | 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 > ... ```