summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
| | |
| \ \
*-. \ \ 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
* | | | | Update build_meta.rst (#3381)Anderson Bravalheri2022-06-181-36/+38
|\ \ \ \ \
| * | | | | 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.
* | | | | | 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
| | | | |
* | | | | Centralize intersphinx_mapping config for docsAnderson Bravalheri2022-06-161-9/+8
| | | | |
* | | | | Add note about possible improvementAnderson Bravalheri2022-06-161-0/+11
| | | | |
* | | | | Update quickstart to make it more streamlineAnderson Bravalheri2022-06-152-54/+87
| | | | |
* | | | | [Docs] Improve instructions for dealing with version (#3374)Anderson Bravalheri2022-06-151-95/+104
|\ \ \ \ \
| * | | | | 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
| | | | | |
* | | | | | Merge pull request #3376 from venthur/fix_spellAnderson Bravalheri2022-06-142-2/+2
|\ \ \ \ \ \ | |/ / / / / |/| | | | | fixed some spelling mistakes,
| * | | | | fixed some spelling mistakes,Bastian Venthur2022-06-142-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | that's all :)
* | | | | | [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-145-25/+58
|\ \ \ \ \
| * | | | | Add remark about install commandAnderson Bravalheri2022-06-141-2/+15
| | | | | |
| * | | | | Merge docs on deprecated commandsAnderson Bravalheri2022-06-145-25/+45
| | | | | | | | | | | | | | | | | | | | | | | | Also add a not about modern ways of generating ``sdists`` and ``wheel``.
| * | | | | Move userguide/commands to deprecated/commandsAnderson Bravalheri2022-06-141-0/+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-1315-412/+519
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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
| | | | | | |
| | | * | | | Apply suggestions from code reviewAnderson Bravalheri2022-06-133-4/+4
| | | | | | |
| | | * | | | Update userguide on `miscellaneous` and `extension`Anderson Bravalheri2022-06-126-177/+247
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a continuation of the update effort to de-emphasize `distutils` and make the documentation more consistent. The main targets of the changes are the files `docs/userguide/miscellaneous` and `docs/userguide/extension`. Changes: - Extracted text about automatic resource extraction and the zip-safe flag from `userguide/miscellaneous` to `deprecated/resource_extraction` and `deprecated/zip_safe`. - These configuration parameters are commonly associated with ``eggs``/``easy_install``/``pkg_resources``, and therefore are obsolete. Leaving them around in the main parts of the documentation just confuses users. - The text in the new files were updated. - Extracted text about additional metadata from `userguide/miscellaneous` into the existing `userguide/extension` document. - Updated `userguide/extension` to better reflect the status of the setuptools project. The text was also changed to explain a little bit more what is the relationship between ``setuptools`` and ``distutils``. - Removed `userguide/functionalities_rewrite`. This file was virtually empty and not bringing any extra value to the docs.
| | * | | | | Apply suggestions from code reviewAnderson Bravalheri2022-06-131-4/+4
| | | | | | |
View Lorry Controller Status