summaryrefslogtreecommitdiff
path: root/docs/userguide/quickstart.rst
Commit message (Collapse)AuthorAgeFilesLines
* 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.
* Get rid of trailing spaces, mainly in docsDimitri Papadopoulos2022-11-201-1/+1
|
* Fix typoMartin Braquet2022-10-211-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.
* [Docs] Typo in QuickstartAtiab Bin Zakaria2022-08-171-1/+1
|
* Clarify 'setup.py' on quistartAnderson Bravalheri2022-08-151-4/+25
|
* Update docs to reflect the implementation of PEP 660Anderson Bravalheri2022-08-061-10/+9
|
* docs: Update quickstart.rst (#3464)Anderson Bravalheri2022-08-061-11/+11
|\
| * quickstart docs: Add comment about optional `packages.find`Anderson Bravalheri2022-08-061-0/+3
| |
| * Update quickstart.rstGéry Ogam2022-07-251-12/+9
| |
* | type in quickstart.rstEdgar Riba2022-07-291-1/+1
| |
* | Fix typo `find_namespaces:` to `find_namespace:`Brody Rampono2022-07-251-2/+2
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I believe the correct `setup.cfg` packaging option is `find_namespace:`, not `find_namespaces:` I can't find any other references to `find_namespaces` in the docs or repository. Using `find_namespaces:` causes packaging to fail. Example to reproduce: ``` . ├── pyproject.toml ├── setup.cfg └── src ├── pkg1 │   └── namespace │   └── __init__.py └── pkg2 └── __init__.py ``` Contents of `pyproject.toml`: ``` [build-system] requires = ["setuptools"] build-backend = "setuptools.build_meta" ``` Contents of `setup.cfg`: ``` [metadata] name = pkg_test [options] packages = find_namespaces: package_dir = =src [options.packages.find] where = src ``` ``` $ pip install . > ... > error: package directory 'src/find_namespaces:' does not exist > ... ```
* Reorder words in footnote to improve the meaningAnderson Bravalheri2022-06-171-1/+1
|
* docs: Reorder example tabsAnderson Bravalheri2022-06-161-58/+59
|
* Change wording from *experimental* to *beta*Anderson Bravalheri2022-06-161-7/+7
|
* Clarify warnings and notes in documentation about experimental pyproject.tomlAnderson Bravalheri2022-06-161-8/+6
|
* 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
|
* Improve docs by avoiding confusion with distutilsAnderson Bravalheri2022-06-121-8/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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`
* Missing the word "pyproject.toml" in Quickstart.Michael Loyd2022-05-241-1/+1
| | | In the sentence "If you are experimenting with configuration using, or have version of..."
* Warn about deprecation of behaviour that considers modules/packages as data ↵Anderson Bravalheri2022-05-161-1/+1
|\ | | | | | | when include_package_data=True (#3308)
| * Quickfix missing comment mark in docsAnderson Bravalheri2022-05-051-1/+1
| |
* | Clarify that `pyproject.toml` config will not be removedJim Garrison2022-04-291-1/+1
|/ | | | | | | | | | | | | | | | | The current documentation regarding `pyproject.toml` claims that support for using it to specify package metadata and build configuration options might be "completely removed" in a future release. However, nowadays it is clear (https://github.com/pypa/setuptools/issues/1688#issuecomment-1079706929 and #3214) that `pyproject.toml` is not going anywhere, is here to stay, and is in fact expected to be the preferred format in the future. This makes an incremental change toward that future by clarifying that `pyproject.toml` support will not be removed in a future release of setuptools.
* Fix typo in docsVladimir Berlev2022-04-141-1/+1
|
* Fix typo in quickstart sectionPablo Cárdenas2022-03-261-1/+1
| | | | | The function should be between quotes like a string. cli-name = mypkg.mymodule:some_func => cli-name = "mypkg.mymodule:some_func"
* Fix `bellow` typo in docsMathieu Kniewallner2022-03-241-1/+1
|
* Add back notes about editable install and pyproject metadataAnderson Bravalheri2022-03-241-1/+17
| | | | On further examination, `pip` seems to fail if `setup.py` is missing.
* Fix wrong version reference in quickstartAnderson Bravalheri2022-03-241-1/+1
|
* Improve note about setup.pyAnderson Bravalheri2022-03-241-1/+2
|
* Add missing prepositionAnderson Bravalheri2022-03-241-1/+1
|
* Add module to entry_point example in quickstartAnderson Bravalheri2022-03-241-4/+4
|
* Improve text about CLI entry-point in quickstartAnderson Bravalheri2022-03-241-2/+3
|
* Fix example of environment maker for dependencies in quickstartAnderson Bravalheri2022-03-241-1/+1
|
* Restore tip about editable installsAnderson Bravalheri2022-03-241-20/+3
| | | | | Experiments with pip 21.1 confirm that it can use editable mode even when `setup.py` is missing.
* Small doc improvementsAnderson Bravalheri2022-03-171-1/+1
|
* Apply suggestions from code reviewAnderson Bravalheri2022-03-171-3/+3
| | | Co-authored-by: Steven Silvester <steven.silvester@ieee.org>
* Clarify extras in entry-points are deprecatedAnderson Bravalheri2022-03-171-1/+1
|
* Improve notes on quickstartAnderson Bravalheri2022-03-171-37/+47
|
* Clarify editable installs note in quickstartAnderson Bravalheri2022-03-171-21/+22
|
* Add note about editable installs in quickstartAnderson Bravalheri2022-03-171-1/+17
|
* Improve data files section in quickstartAnderson Bravalheri2022-03-171-3/+27
|
* Improve dependencies section in quickstartAnderson Bravalheri2022-03-171-16/+41
|
* Improve entry-points section in the quickstartAnderson Bravalheri2022-03-171-11/+37
|
* Improve discovery section in the quickstartAnderson Bravalheri2022-03-171-10/+55
|
* Fix link to keywordsAnderson Bravalheri2022-03-171-1/+1
|
* Add some missing references in the quickstartAnderson Bravalheri2022-03-171-5/+5
|
* Mention experimental pyproject config in the quickstartAnderson Bravalheri2022-03-171-7/+37
|
* Add missing link to PyPUG MANIFEST.in docsAnderson Bravalheri2022-03-031-1/+1
|
View Lorry Controller Status