summaryrefslogtreecommitdiff
path: root/docs/userguide
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
*-. Allow `file` directive for dependencies (#3253, #3255)Anderson Bravalheri2022-06-192-15/+34
|\ \
| | * Allow `file:` for `dependencies` and `optional-dependencies` in pyproject.tomlAarni Koskela2022-04-081-10/+22
| | |
| * | Update docs/userguide/declarative_config.rstAnderson Bravalheri2022-06-141-1/+3
| | |
| * | Allow `file:` for `requires` statements in setup.cfgAarni Koskela2022-06-141-5/+10
| | | | | | | | | | | | Refs #1951
* | | docs/userguide/ext_modules.rst: Also mention extra_compile_args, extra_link_argsMatthias Koeppe2022-06-171-2/+4
| | |
* | | docs/userguide/ext_modules.rst: Add more detail on processing ↵Matthias Koeppe2022-06-171-0/+20
| | | | | | | | | | | | sysconfig/environment vars
* | | Update docs/userguide/datafiles.rstAnderson Bravalheri2022-06-171-2/+1
| | |
* | | Reorder words in footnote to improve the meaningAnderson Bravalheri2022-06-173-3/+3
| | |
* | | docs: Reorder example tabsAnderson Bravalheri2022-06-163-150/+150
| | |
* | | Change wording from *experimental* to *beta*Anderson Bravalheri2022-06-165-38/+33
| | |
* | | Clarify warnings and notes in documentation about experimental pyproject.tomlAnderson Bravalheri2022-06-163-32/+18
| | |
* | | Add more reference linksAnderson Bravalheri2022-06-161-3/+5
| | |
* | | Add note about possible improvementAnderson Bravalheri2022-06-161-0/+11
| | |
* | | Update quickstart to make it more streamlineAnderson Bravalheri2022-06-151-54/+86
| | |
* | | Promote title levelAnderson Bravalheri2022-06-141-1/+1
| | |
* | | Small fixes in the rstAnderson Bravalheri2022-06-141-3/+1
| | |
* | | Reorganize sections regarding versionAnderson Bravalheri2022-06-141-94/+92
| | |
* | | Add warning about calling setup.py directlyAnderson Bravalheri2022-06-141-0/+13
| | |
* | | [Docs] Move Cython remarks to the new ext_modules page (#3373)Anderson Bravalheri2022-06-143-55/+53
|\ \ \
| * | | Simplify text about CythonAnderson Bravalheri2022-06-141-23/+21
| | | |
| * | | [Docs] Move Cython remarks to the new ext_modules pageAnderson Bravalheri2022-06-143-55/+55
| | | | | | | | | | | | | | | | | | | | | | | | This helps to consolidate all the information about extensions in a single place and make it easier for users to find the correct guidance.
* | | | [Docs] Consolidate sdist and MANIFEST.in info into a single document (#3372)Anderson Bravalheri2022-06-142-40/+48
|\ \ \ \ | |/ / / |/| | |
| * | | Add remarks and example for MANIFEST.inAnderson Bravalheri2022-06-141-0/+32
| | | |
| * | | Consolidate sections about sdist contents in a single documentAnderson Bravalheri2022-06-142-40/+16
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing section about `sdist` in `userguide/distribution` seems to have duplicated content when compared to another section in `userguide/miscellaneous`. We can combine these two sections and simplify the documentation. Changes: - Consolidate text about `sdist` contents and MANIFEST.in into a single place. - De-emphasize ``distutils`` and the history of ``setuptools`` (new users might not know about it, which would make them less confuse).
* | | [Docs] Move command description to the deprecated practice section (#3371)Anderson Bravalheri2022-06-142-567/+0
|\ \ \
| * | | Merge docs on deprecated commandsAnderson Bravalheri2022-06-141-1/+0
| | | | | | | | | | | | | | | | Also add a not about modern ways of generating ``sdists`` and ``wheel``.
| * | | Move userguide/commands to deprecated/commandsAnderson Bravalheri2022-06-141-566/+0
| |/ /
* | | Improve remark about external dependenciesAnderson Bravalheri2022-06-141-2/+3
| | |
* | | Add remarks to docs on extension modulesAnderson Bravalheri2022-06-141-1/+15
| | |
* | | Add small exampleAnderson Bravalheri2022-06-141-0/+42
| | |
* | | Minor formatting/editorial improvements on ext_modules docsAnderson Bravalheri2022-06-141-30/+40
| | |
* | | docs/userguide/ext_modules.rst: More sysconfig variablesMatthias Koeppe2022-06-141-1/+2
| | |
* | | docs/userguide/ext_modules.rst: Add more specifics about Extension attributesMatthias Koeppe2022-06-142-1/+10
| | |
* | | docs/userguide/ext_modules.rst: NewMatthias Koeppe2022-06-141-0/+40
|/ /
| |
| \
| \
| \
*---. \ Doc improvements (#3363, #3364, #3367)Anderson Bravalheri2022-06-137-411/+280
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | - Improve docs by avoiding confusion with distutils - Update dependency management docs - Update userguide on miscellaneous and extension
| | | * | Add note about availability of entry-pointsAnderson Bravalheri2022-06-131-1/+11
| | | | |
| | | * | Language adjustmentsAnderson Bravalheri2022-06-131-4/+4
| | | | |
| | | * | Remove unused partsAnderson Bravalheri2022-06-132-14/+1
| | | | |