summaryrefslogtreecommitdiff
path: root/docs/build_meta.rst
Commit message (Collapse)AuthorAgeFilesLines
* Use separated import statement to avoid copying namesAnderson Bravalheri2023-04-201-5/+3
|
* 🎨📝 Fix in-tree PEP 517 backend wrapper exampleSviatoslav Sydorenko2023-04-161-9/+14
| | | | | | | | | | | | | | | | Before this patch, the documentation suggested the package authors to declare a fixed set of hooks inherited from setuptools. But this approach turned out non-future proof. Over time, as `setuptools` added support for editable installs, it introduced new hooks per PEP 660. But if one were to follow the outlined example, they'd end up with an in-tree build backend that does not support editable installs, nor would it re-export any hooks that might be added in future versions of setuptools, implementing any new standards that may emerge over time. This change demonstrates an approach that would allow the thin wrapper authors to get the new hooks that setuptools may add over time. Ref: https://github.com/ansible/ansible/pull/79606#discussion_r1080753862
* Use Sphinx :pep: role to link directly to PEPsHugo van Kemenade2023-01-141-1/+1
|
* fix documentation for dynamic build dependenciesMax Bachmann2022-12-201-2/+2
|
* Get rid of trailing spaces, mainly in docsDimitri Papadopoulos2022-11-201-3/+3
|
* Remove wheel dependency in exampleAnderson Bravalheri2022-07-081-1/+1
|
* Add beta status to 'file' directive for reading dependenciesAnderson Bravalheri2022-06-191-1/+1
|
* Update build_meta.rstcdfarrow2022-06-181-10/+11
|
* Update docs/build_meta.rstcdfarrow2022-06-181-3/+3
| | | Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* Update build_meta.rstcdfarrow2022-06-171-32/+33
| | | | | | | | | Mainly grammar/style tweaks... which turned into a few more thoughts: About this statement: "decide which program to use to 'build from source' (the default is ``setuptools``)." I think 'default' conveys the wrong impression here when it is explaining the new way of doing things. PEP517 says, "(build) tools should revert to the legacy behaviour of running setup.py" Maybe a footnote would be better saying it is a fallback, for backward compatibility. (But, all the same, this is interesting information that now explains to me why 'py -m build' worked before I had tried using a pyproject.toml file.) Line 37: ``build_meta`` implements ``setuptools``'s build system support. This seems out of place, and doesn't make sense. build_meta hasn't been mentioned yet in this article. Maybe this sentence could go before line 61. Line 26-28: This seems like low-level detail that is out of place in this article. If you want to keep it, maybe add a note that the default directory is dist\. **The "bullet items" under the PEP517 section aren't formatting correctly in the Preview. Please check that I haven't messed anything up there in the final render.
* Update dependency management docsAnderson Bravalheri2022-06-121-0/+3
| | | | | | | | | | - Extract `depencency_liks` section to a new file: `deprecated/dependency_links.rst` - Add note about directly URLs not being accepted in PyPI. - Simplify intro about build system requirement. - Simplify intro about optional dependencies. - Fix confusion in example about "Project" and "Package". - "Demote" section about extras in entry-points to a note.
* Apply suggestions from code reviewAnderson Bravalheri2022-05-161-1/+1
|
* Some small typos and grammar fixesMatt Hall2022-04-261-13/+14
| | | | | | - Tense changed in first paragraph: should be either past or present; present seems fair since a lot of people still use or even need `setup.py`. - Line 20: missing 'the' - Under 'How to use it?' I added a Python file to the source tree; seems like the sort of thing a beginner could get confused about ("where does my code go?"). - A couple of small typos.
* fix typoMarkus Bong2022-04-211-1/+1
|
* Mention experimental pyproject.toml support in discovery docsAnderson Bravalheri2022-03-171-0/+2
|
* Merge pull request #2897 from abravalheri/improve-docsJason R. Coombs2022-01-301-0/+82
|\ | | | | Docs: Add instructions about `build_meta` wrappers as alternative to dynamic `setup_requires`
| * Mention environment markers as alternativeAnderson Bravalheri2021-11-191-1/+6
| |
| * Add documentation about build_meta wrappersAnderson Bravalheri2021-11-191-0/+77
| |
* | Stop mentioning `wheel` in the context of PEP 517Sviatoslav Sydorenko2022-01-271-2/+3
| | | | | | | | | | | | This dependency is exposed automatically by setuptools and the users do not need to declare it explicitly — it will be installed by PEP 517 front-ends automatically, when building wheels.
* | doc: Fix trailing spaces, tabs, and missing newlines at end of file.Julien Palard2022-01-241-14/+14
|/
* Prefer "command" to "function". Use direct imperative voice.Jason R. Coombs2021-09-041-3/+3
|
* build_meta: Clarify the reasons for project requirements in pyproject.tomlIan Wienand2021-08-091-1/+5
|
* Fix a broken external linkclint-lawrence2021-05-251-1/+1
|
* docs (build_meta): fix spelling mistakeDrew2020-12-251-1/+1
|
* docs: recommend pypa buildHenry Schreiner2020-12-221-8/+5
|
* 📝 Recover interdoc links & correct broken syntaxSviatoslav Sydorenko2020-10-161-1/+2
|
* Use canonical extension for docs.Jason R. Coombs2020-09-231-0/+89