summaryrefslogtreecommitdiff
path: root/docs/userguide
Commit message (Collapse)AuthorAgeFilesLines
* Fix typo in docsBo Bayles2023-04-251-1/+1
|
* Fix sphinx errorAnderson Bravalheri2023-04-201-1/+1
|
* docs: Add a note about historical `wheel` use in `requires`Michał Górny2023-04-201-0/+11
| | | | | | | | | | Add a note explaining that the `wheel` requirement that used to be historically used in documentation was incorrect. This also explains why it can frequently be found in existing projects, and what problems it causes. I find myself repeatedly explaining it, so I think having a single official source would be better. Incorporates suggestions from Anderson Bravalheri.
* Clarify language re: function argumentsMoshe Kaplan2023-03-151-2/+2
| | | Configured indicates that the function code's itself would be configured, not that it is used by an external party. Switch verb to "used" to be clearer as to how the function is being used.
* Fix typo in docs/userguide/extension.rsthbielenia2023-02-181-1/+1
|
* Mention limitation in editable docsAnderson Bravalheri2023-02-171-0/+5
|
* Update note about SETUPTOOLS_ENABLE_FEATURESAnderson Bravalheri2023-02-131-15/+6
|
* Fix error in docsAnderson Bravalheri2023-01-231-0/+1
|
* Update docs to clarify dangling listAnderson Bravalheri2023-01-231-8/+9
|
* Docs: Link directly to PEPs (#3770)Anderson Bravalheri2023-01-201-1/+1
|\
| * Use Sphinx :pep: role to link directly to PEPsHugo van Kemenade2023-01-141-1/+1
| |
* | Add versionchanged note to docsAnderson Bravalheri2023-01-202-8/+4
| |
* | Adapt note about file directive and MANIFEST.inAnderson Bravalheri2023-01-192-10/+20
| |
* | Update setuptools sdist docs warningSinclert Pérez2023-01-191-3/+3
| |
* | DOC: fix section for python_requires in setup.cfgMike Taves2023-01-181-1/+1
|/
* docs: Remove repeated mention of LDFLAGS environment variableMatthew Feickert2023-01-111-2/+2
| | | | | * The first instance of LDFLAGS is removed instead of the second to match the style of the preceding environment variables.
* Merge: Docs: Modify table for tool.setuptools.dynamic to mention ↵Anderson Bravalheri2023-01-111-4/+10
|\ | | | | | | content-type (#3764)
| * Docs: Modify table for tool.setuptools.dynamic to mention content-typeAnderson Bravalheri2023-01-111-4/+10
| |
* | Improve example docs for setup.cfg and pyproject.tomlMike Taves2022-11-262-2/+8
|/
*---. Merge spelling/space improvements (#3695, #3698, #3697, #3699)Anderson Bravalheri2022-11-233-5/+5
|\ \ \
| | | * Get rid of trailing spaces, mainly in docsDimitri Papadopoulos2022-11-202-2/+2
| |_|/ |/| |
| | * Fix non-ASCII homoglyph of `v`Dimitri Papadopoulos2022-11-211-1/+1
| |/ |/|
| * Fix typos found by codespellDimitri Papadopoulos2022-11-201-2/+2
|/
* Fix typo in docs/userguide/development_mode (#3664)Anderson Bravalheri2022-11-111-1/+1
|\
| * Minor stylistic changeAnderson Bravalheri2022-11-111-1/+2
| |
| * Fix typo in docs/userguide/development_mode.rstshripadbadithe2022-11-061-2/+1
| |
* | Highlight in docs: `attr` directive needs MANIFEST.in config / SCM plugin ↵Anderson Bravalheri2022-11-102-0/+13
|\ \ | |/ |/| | | (#3662)
| * Highlight in docs: 'attr' directive needs MANIFEST.in config / SCM pluginAnderson Bravalheri2022-11-042-0/+13
| |
* | Improve warnings in editable install (#3569)Anderson Bravalheri2022-11-041-1/+1
|\ \ | |/ |/|
| * Fix misspelling in docs/userguide/development_mode.rstAnderson Bravalheri2022-10-111-1/+1
| |
* | Fix typoMartin Braquet2022-10-211-1/+1
| |
| |
| \
*-. \ Merge PRs #3636 #3634 #3633 #3595 #3576 #3569 #3564Anderson Bravalheri2022-10-141-0/+11
|\ \ \ | | |/
| | * Document CWD limitations in editable docsAnderson Bravalheri2022-08-261-0/+11
| |/
* | Update pyproject_config.rst (#3571)Anderson Bravalheri2022-10-111-1/+1
|\ \
| * | Update pyproject_config.rstPer Jensen2022-08-281-1/+1
| |/ | | | | | | | | The sequence of TOML datatypes and Python datatypes are reversed, which is a bit confusing. I suggest to align the sequence, so that array and table aligns with list and dict
* | Update docs/userguide/distribution.rst Jason Veatch2022-10-101-3/+3
| | | | | | | | | | Thanks @abravalheri for this change! Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* | Fix #3419. Update example versions to be PEP440-compliantJason Veatch2022-10-051-21/+28
| |
* | Docs: fix urlAnderson Bravalheri2022-09-151-1/+1
|/
* [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
| |\