summaryrefslogtreecommitdiff
path: root/docs/userguide
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
* | | 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
| | | | |
| | | * | Apply suggestions from code reviewAnderson Bravalheri2022-06-131-2/+2
| | | | |
| | | * | Update userguide on `miscellaneous` and `extension`Anderson Bravalheri2022-06-123-177/+117
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| | | | |
| | * | | Update dependency management docsAnderson Bravalheri2022-06-121-160/+100
| | |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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-06-131-2/+2
| | | |
| * | | Improve docs by avoiding confusion with distutilsAnderson Bravalheri2022-06-123-53/+45
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing docs seem to assume that the user is familiar with the history of packaging in the Python ecosystem (or at least know what is `distutils`). Since that is not always the case and that `distutils` is in the process of being adopted by `setuptools`, the documentation should be changed to minimize mentions to `distutils` and avoid expecting too much knowledge from the users. The benefit of this approach is that it can make the docs more accessible and easier to understand. Changes: - Modify landing page to clarify what `setuptools` does (making it more clear to understand for beginners). - Remove mentions to `distutils`, `transition to PEP 517` from `userguide/index`. - Instead the text is changed to have a more "introductory" tone. - Remove mentions to `distutils` from the Quickstart. - Remove `python2` from the intersphinx mapping - it was causing trouble redirecting glossary terms to Python2 docs, instead of Python3. - Modify documentation about development mode to be more aligned with current practices (i.e. using `pip install -e .`) - In this process all documentation about running `setuptools` commands in `distutils` projects was moved to a new file in `docs/deprecated/running_commands.rst`
* | | Fix up subsections of the "Entry Points for Plugins" sectionSaniya Maheshwari2022-06-121-15/+10
| | | | | | | | | | | | | | | - Convert the `importlib.metadata` subsection into a Tip. - Remove the 'Summary' subsection header.
* | | Apply suggestions from code reviewSaniya Maheshwari2022-06-121-3/+4
| | | | | | | | | Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* | | Added a single space around the `=` sign in `setup.py` snippetsSaniya Maheshwari2022-06-121-5/+5
| | | | | | | | | | | | | | | | | | Have checked that the snippets continue to work with this space included. The space improves readability, hence this is probably a good addition.
* | | Fixed up indentation issueSaniya Maheshwari2022-06-121-5/+5
| | | | | | | | | | | | | | | Some extra indentation was causing the code block to be interpreted as a code block within a blockquote.
* | | Added a few lines to make the purpose of the syntax clearSaniya Maheshwari2022-06-121-1/+21
| | | | | | | | | | | | | | | | | | A few lines have been added in each of the sections on Console Scripts, GUI scripts and Entry Points for Plugins. A line has also been added at the end of the Syntax section to further make things clear.
* | | Section on Entry Points SyntaxSaniya Maheshwari2022-06-121-10/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Matter is courtesy of @abravalheri. Have removed the `.ini` syntax highlighting of the code blocks so that the syntax does not appear specific to `setup.cfg` but more general-purpose. Have also moved this section down to the end of the document so that users can refer to it after having a basic understanding of how each of console scripts, GUI scripts, and entry points work.
View Lorry Controller Status