Pradyun Gedam
902b9e7a1a
Merge pull request #10536 from pradyunsg/docs/fix-wordin
2021-10-18 20:27:15 +01:00
Pradyun Gedam
b576329791
Fix documentation about when setup.py clean is run
...
It is only run on failure to build wheels.
2021-10-18 20:22:52 +01:00
Pradyun Gedam
eddd6dde3b
Correct mistake in documentation on Unix configuration file paths
...
The order was flipped, which implied the wrong thing.
2021-10-17 15:08:08 +01:00
Pradyun Gedam
fc6d7778a5
Merge pull request #10569 from aphedges/fix-typos
2021-10-15 19:25:34 +01:00
Pradyun Gedam
aa89947b01
Improve our towncrier template, to do the right thing after releases
...
This also adds a bunch of comments, which should serve as useful guides
to future humans that work on these files.
2021-10-15 15:11:43 +01:00
Alex Hedges
e1f81bfa4d
Fix many typos
2021-10-11 15:48:17 -04:00
Pradyun Gedam
a07bfb33a0
Merge pull request #10495 from sbidoul/out-of-tree-build-flag
2021-10-02 12:34:24 +01:00
Pradyun Gedam
989ec2136d
Merge pull request #10497 from pradyunsg/docs/build-system-reference
...
Add a dedicated "Build system interface" reference section
2021-09-30 07:09:27 +01:00
Pradyun Gedam
4d7d38a3c0
Addresss spelling nit
...
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2021-09-30 06:07:24 +01:00
Pradyun Gedam
d6d72172e8
Rephase historical note about easy_install/setup_requires
...
It wasn't clear what "those dependencies" refers to.
2021-09-29 20:02:07 +01:00
Pradyun Gedam
25a31d49e5
Improve build system interface docs based on feedback
...
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2021-09-29 19:57:43 +01:00
Pradyun Gedam
229808807b
Update according to the PEP 660 implementation
2021-09-29 19:10:03 +01:00
Pradyun Gedam
76cdf8f7e1
Merge pull request #10521 from MrMino/debugging_pip_docs
...
Add a section about debugging to development docs
2021-09-29 18:37:44 +01:00
ziebam
6ab7dba97c
Remove the redundant snippets
2021-09-29 17:15:04 +02:00
Blazej Michalik
2c75f20908
Add a section about debugging to development docs
2021-09-29 01:32:22 +02:00
ziebam
32879cd920
Change the docs to suggest .venv instead of venv
2021-09-29 00:06:48 +02:00
Pradyun Gedam
d37aa211b4
Add a dedicated "Build system interface" reference section
...
This reworks a substantial portion of our existing build system related
documentation, putting it all in a single location.
There are certain areas that have been rephrased or rewritten:
- The setup.py interface is now considered an implementation detail.
- The setup.py interface is explicitly noted as a legacy interface, due
for removal.
- The pyproject.toml interface now has clearer documentation on how it
is used and how it operates.
- Clearer separation of `--use-pep-517` and `--no-build-isolation`, to
make the difference between the two clearer.
2021-09-28 21:10:32 +01:00
Stéphane Bidoul
040cc391ba
Make in-tree-build the default
...
Add an out-of-tree-build feature flag to ease the transition.
2021-09-25 13:11:01 +02:00
Stéphane Bidoul
729eb5d627
Improve docs
...
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2021-09-21 11:18:01 +02:00
Stéphane Bidoul
5a38ee7ad2
Add docs example for pip list and editable installs
2021-09-21 11:18:01 +02:00
Pradyun Gedam
992d954ebd
Fix broken references in documentation
2021-09-18 09:11:42 +01:00
Pradyun Gedam
89326c8a9f
Merge pull request #10450 from pradyunsg/docs/requirements-format
...
Add a dedicated page for "Requirements File Format"
2021-09-17 16:51:58 +01:00
Pradyun Gedam
005fc1c027
Rephrase note about the file format
...
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2021-09-11 10:14:56 +01:00
Tzu-ping Chung
1ca0807890
Merge pull request #10430 from meowmeowmeowcat/patch-1
2021-09-11 04:01:29 +08:00
Pradyun Gedam
5f3a13d98f
Explicitly mention requirements.txt, to perform better in web searches
...
This is basically based on a wild guess, that the search engines would
rank this higher in searches about requirements.txt files, if we mention
the file explicitly here.
2021-09-08 08:45:29 +01:00
Pradyun Gedam
3c8462159b
Move "Requirements File Format" docs to reference/
...
This is a better, more visible location for this file format. It is more
discoverable and more likely to show up in search results.
2021-09-08 08:45:29 +01:00
Pradyun Gedam
2ae532ac19
Bring the reference/ section back
...
This was originally the reference to the command line interface for pip.
That is now handled by cli/ pages, which frees up these pages for
describing other aspects of pip.
2021-09-08 08:05:55 +01:00
meowmeowcat
d925e24836
Link to PyPUG instead of Setuptools
2021-09-05 12:24:08 +08:00
Pradyun Gedam
b8fc219418
Merge pull request #10429 from jdufresne/pretend
...
Replace use of pretend library with unitest.mock in tests
2021-09-04 21:04:34 +01:00
Jon Dufresne
8f48b32581
Fix docs build failure
...
Resolves Sphinx error:
.../pip/docs/html/user_guide.rst:1011:undefined label: dependency resolution backtracking
2021-09-04 11:08:45 -07:00
meowmeowcat
1f817dcdca
Update a link of setuptools
2021-09-04 13:17:41 +08:00
meowmeowcat
a4cb77ffd0
Update links of setuptools
2021-09-04 13:08:53 +08:00
Jon Dufresne
4a4103e173
Replace use of pretend library with unitest.mock in tests
...
The pretend library was used by very few tests. In all cases, it is
simple enough to switch to stdlib unitest.mock.
Using stdlib means there is one fewer library to install before running
tests. It can also simplify mypy usage via typeshed.
2021-09-03 16:23:28 -07:00
Jon Dufresne
a775351a38
Clean up leftover references to removed Travis and Azure CI
2021-08-28 20:01:58 -07:00
meowmeowcat
544bdd13a4
Remove python -m
...
Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
2021-08-26 14:29:47 +08:00
meowmeowcat
21abee685c
Add a section for upgrading pip
2021-08-26 13:57:16 +08:00
Pradyun Gedam
9cb23c9b4f
Merge pull request #10279 from pradyunsg/reorg-dependency-resolution-information
2021-08-15 22:18:51 +01:00
Stéphane Bidoul
c1772d9d03
Remove pip list legacy format from documentation
2021-08-15 17:56:43 +02:00
Pradyun Gedam
53e2a5cf0a
Use pip-cli for an example pip invocation
2021-08-13 13:37:46 +01:00
Pradyun Gedam
d7c33065ad
Move section on dependency conflicts to dependency resolution topic
2021-08-13 13:37:46 +01:00
Pradyun Gedam
da6239de97
Move "reduce backtracking" to dependency resolution topic
2021-08-13 13:37:45 +01:00
Nipunn Koorapati
2aab462b7f
Bump mypy to 0.910
...
This notably gets us on a version of mypy that uses modular typeshed:
https://mypy-lang.blogspot.com/2021/05/the-upcoming-switch-to-modular-typeshed.html
which allows us to have finer control over what version of stubs we pull
in from typeshed. Also contains other routine improvements to mypy.
Required a few minor typing changes.
Add flag --show-error-code so errors look like this
src/pip/_internal/network/auth.py:70: error: Incompatible types in assignment
(expression has type "None", variable has type Module) [assignment]
rather than
src/pip/_internal/network/auth.py:70: error: Incompatible types in assignment
(expression has type "None", variable has type Module)
2021-08-09 16:47:02 -07:00
Tzu-ping Chung
f0323c7888
Merge pull request #10200 from uranusjr/release-procedure-improvements
2021-08-07 17:58:43 +08:00
Tzu-ping Chung
c18bc1661d
Merge pull request #10164 from pradyunsg/python-3.10
2021-08-07 10:42:16 +08:00
Pradyun Gedam
0d399df447
Fix a broken link
2021-08-06 14:06:43 +01:00
Pradyun Gedam
86188daa68
Add missing periods
2021-08-06 14:06:36 +01:00
Pradyun Gedam
3dc913a3e5
Remove no-longer-relevant page
2021-08-06 13:56:57 +01:00
Pradyun Gedam
4ee9a4af25
Add Python 3.10 support
2021-08-06 13:42:31 +01:00
Hugo van Kemenade
8e473886d6
Link directly to the new location to avoid an extra click and load
2021-08-04 12:16:03 +03:00
Pradyun Gedam
086a85150d
Bump up to Sphinx 4
...
Using the newer versions of Sphinx enables using newer versions of the
Sphinx theme we use.
2021-07-28 10:49:25 +01:00
