📝 Add initial sphinx ext for per-doc feedbacks #8848

webknjaz · 2020-09-05T19:03:18Z

Resolves #8783

pradyunsg · 2020-09-05T19:33:50Z

https://pip--8848.org.readthedocs.build/en/8848/

Uhhh... This is extremely invasive IMO.

webknjaz · 2020-09-05T21:50:16Z

@pradyunsg I thought so. But atm I'm just doing what I was asked to do. It's easier to reason about stuff when there's a preview :)

webknjaz · 2020-09-05T21:53:50Z

I've colored it a bit. I'll let @nlhkabu / @jdittrich / @georgiamoon decide how to deal with the invasiveness.

FWIW it's a good start and can be tweaked.

news/8848.doc

jdittrich · 2020-09-06T13:06:04Z

I'll let @nlhkabu / @jdittrich / @georgiamoon decide how to deal with the invasiveness.

Imho it is too invasive on such a short page, but totally OK on a longer page. We could hide one in case of short pages (don't know how hard this is). We could also make the box less big in general:

McSinyx · 2020-09-06T13:55:03Z

docs/docs_feedback_sphinxext.py

+      1. What problem were you trying to solve when you came to this page?
+
+      2. What content was useful?
+
+      3. What content was not useful?


Suggested change

1. What problem were you trying to solve when you came to this page?

2. What content was useful?

3. What content was not useful?

1. What problem were you trying to solve when you came to this page?

2. What content was useful?

3. What content was not useful?

The rendered list seems to be over-indented, probably because triple-quotes preserve whitespace. I can't view the reST output (after this extension is applied) ~~due to the theme~~ (it's just not trivially possible), but I think generally it'd be safer to declare all these literals as module level constants to avoid accidentally messing up indentation.

I hear you but because it's also augmented with another line with context-specific var, I'm not sure if moving it on the module level is a good idea. After all, we need to keep some sort of common indentation level here and 3 lines below.

I guess I'll just experiment with dedenting both.

I'd say: check if it's creating a blockquote in the final HTML. If it is, then you know that things are indented too far.

It is, and I was also concern about other texts provided as indented triple quoted literals, e.g. Did this article help? (relative to .. important). Sphinx is pretty relaxed and still renders the content even if it doesn't align with important, but I think it'd be easier to notice whitespace issues if the reST is provided as something close to unindented literals, which we can then str.format on.

pfmoore · 2020-09-06T16:27:39Z

I agree with @pradyunsg - this is too intrusive. Top or bottom is fine, but I'm not keen on both.

(Also, I think having the banner on the changelog page is probably a bit much, although I understand that it's an all-or-nothing thing because of the way it's implemented).

pradyunsg · 2020-09-06T16:43:36Z

It's not an all-or-nothing proposition since we have the document name in the code that's adding the $thing. We can have conditionals to "opt out" for certain pages, if we want.

webknjaz · 2020-09-06T19:10:34Z

It's not an all-or-nothing proposition since we have the document name in the code that's adding the $thing. We can have conditionals to "opt out" for certain pages, if we want.

Exactly, we can change this once there's a general consensus on what exactly is needed.

webknjaz · 2020-09-06T21:33:54Z

We could hide one in case of short pages (don't know how hard this is).

The easiest way of doing this is to maintain a list of exclusions I think.

We could also make the box less big in general

Feel free to send a CSS patch with a specific suggestion. "less big" is too broad and is not very well actionable...

webknjaz · 2020-09-06T21:34:31Z

@jdittrich oh, I just looked at the picture again. Are you suggesting to drop the list?

jdittrich · 2020-09-07T16:52:21Z

@jdittrich oh, I just looked at the picture again. Are you suggesting to drop the list?

Yes, that would be one way to make it smaller (which could be particularly important for the top box)

webknjaz · 2020-09-07T18:17:37Z

Alright, so just to clarify the action items now:

drop the list from the top box, but not the bottom one
dedent the list
implement page exclusions (not sure if everybody agrees on this one)

Anything I'm missing?

webknjaz · 2020-09-25T21:23:48Z

So I think I've made it a bit better:

Now the list is only present in the bottom box but not the top one (as requested by @jdittrich) -- see https://pip--8848.org.readthedocs.build/en/8848/development/
It is possible to exclude documents and I've added the news document to the exclude list (:wave: @pfmoore) -- see https://pip--8848.org.readthedocs.build/en/8848/news/
Adjusted the indentation (@McSinyx ✌️)
The top box is hidden if the document RST source has over 50 LOC (@jdittrich 🎉) -- see https://pip--8848.org.readthedocs.build/en/8848/
I've added a number of external toggles so that it's possible to adjust the following w/o the need to look into the monstrous extension implementation:
- box (admonition) type
- the "big doc" threshold
- the target email
- the excluded documents set
- the questions list

Resolves pypa#8783

pradyunsg · 2020-09-27T13:58:41Z

I like it. @nlhkabu and @jdittrich if you reckon this is good to go, let's ship it. :)

nlhkabu · 2020-09-27T17:07:34Z

Looks good to me! Thanks @webknjaz ! ❤️

jdittrich · 2020-09-29T19:41:23Z

thanks!
fine for me, too :)

195: Update pip to 20.3 r=duckinator a=pyup-bot This PR updates [pip](https://pypi.org/project/pip) from **20.2.4** to **20.3**. <details> <summary>Changelog</summary> ### 20.3 ``` - Introduce a new ResolutionImpossible error, raised when pip encounters un-satisfiable dependency conflicts (`8546 <https://github.com/pypa/pip/issues/8546>`_, `8377 <https://github.com/pypa/pip/issues/8377>`_) - Add a subcommand ``debug`` to ``pip config`` to list available configuration sources and the key-value pairs defined in them. (`6741 <https://github.com/pypa/pip/issues/6741>`_) - Warn if index pages have unexpected content-type (`6754 <https://github.com/pypa/pip/issues/6754>`_) - Allow specifying ``--prefer-binary`` option in a requirements file (`7693 <https://github.com/pypa/pip/issues/7693>`_) - Generate PEP 376 REQUESTED metadata for user supplied requirements installed by pip. (`7811 <https://github.com/pypa/pip/issues/7811>`_) - Warn if package url is a vcs or an archive url with invalid scheme (`8128 <https://github.com/pypa/pip/issues/8128>`_) - Parallelize network operations in ``pip list``. (`8504 <https://github.com/pypa/pip/issues/8504>`_) - Allow the new resolver to obtain dependency information through wheels lazily downloaded using HTTP range requests. To enable this feature, invoke ``pip`` with ``--use-feature=fast-deps``. (`8588 <https://github.com/pypa/pip/issues/8588>`_) - Support ``--use-feature`` in requirements files (`8601 <https://github.com/pypa/pip/issues/8601>`_) Bug Fixes --------- - Use canonical package names while looking up already installed packages. (`5021 <https://github.com/pypa/pip/issues/5021>`_) - Fix normalizing path on Windows when installing package on another logical disk. (`7625 <https://github.com/pypa/pip/issues/7625>`_) - The VCS commands run by pip as subprocesses don't merge stdout and stderr anymore, improving the output parsing by subsequent commands. (`7968 <https://github.com/pypa/pip/issues/7968>`_) - Correctly treat non-ASCII entry point declarations in wheels so they can be installed on Windows. (`8342 <https://github.com/pypa/pip/issues/8342>`_) - Update author email in config and tests to reflect decommissioning of pypa-dev list. (`8454 <https://github.com/pypa/pip/issues/8454>`_) - Headers provided by wheels in .data directories are now correctly installed into the user-provided locations, such as ``--prefix``, instead of the virtual environment pip is running in. (`8521 <https://github.com/pypa/pip/issues/8521>`_) Vendored Libraries ------------------ - Vendored htmlib5 no longer imports deprecated xml.etree.cElementTree on Python 3. - Upgrade appdirs to 1.4.4 - Upgrade certifi to 2020.6.20 - Upgrade distlib to 0.3.1 - Upgrade html5lib to 1.1 - Upgrade idna to 2.10 - Upgrade packaging to 20.4 - Upgrade requests to 2.24.0 - Upgrade six to 1.15.0 - Upgrade toml to 0.10.1 - Upgrade urllib3 to 1.25.9 Improved Documentation ---------------------- - Add ``--no-input`` option to pip docs (`7688 <https://github.com/pypa/pip/issues/7688>`_) - List of options supported in requirements file are extracted from source of truth, instead of being maintained manually. (`7908 <https://github.com/pypa/pip/issues/7908>`_) - Fix pip config docstring so that the subcommands render correctly in the docs (`8072 <https://github.com/pypa/pip/issues/8072>`_) - replace links to the old pypa-dev mailing list with https://mail.python.org/mailman3/lists/distutils-sig.python.org/ (`8353 <https://github.com/pypa/pip/issues/8353>`_) - Fix example for defining multiple values for options which support them (`8373 <https://github.com/pypa/pip/issues/8373>`_) - Add documentation for the ResolutionImpossible error that helps the user fix dependency conflicts (`8459 <https://github.com/pypa/pip/issues/8459>`_) - Add feature flags to docs (`8512 <https://github.com/pypa/pip/issues/8512>`_) - Document how to install package extras from git branch and source distributions. (`8576 <https://github.com/pypa/pip/issues/8576>`_) ``` ### 20.3b1 ``` =================== Deprecations and Removals ------------------------- - ``pip freeze`` will stop filtering the ``pip``, ``setuptools``, ``distribute`` and ``wheel`` packages from ``pip freeze`` output in a future version. To keep the previous behavior, users should use the new ``--exclude`` option. (`4256 <https://github.com/pypa/pip/issues/4256>`_) - Deprecate support for Python 3.5 (`8181 <https://github.com/pypa/pip/issues/8181>`_) - Document that certain removals can be fast tracked. (`8417 <https://github.com/pypa/pip/issues/8417>`_) - Document that Python versions are generally supported until PyPI usage falls below 5%. (`8927 <https://github.com/pypa/pip/issues/8927>`_) - Deprecate ``--find-links`` option in ``pip freeze`` (`9069 <https://github.com/pypa/pip/issues/9069>`_) Features -------- - Add ``--exclude`` option to ``pip freeze`` and ``pip list`` commands to explicitly exclude packages from the output. (`4256 <https://github.com/pypa/pip/issues/4256>`_) - Allow multiple values for --abi and --platform. (`6121 <https://github.com/pypa/pip/issues/6121>`_) - Add option ``--format`` to subcommand ``list`` of ``pip cache``, with ``abspath`` choice to output the full path of a wheel file. (`8355 <https://github.com/pypa/pip/issues/8355>`_) - Improve error message friendliness when an environment has packages with corrupted metadata. (`8676 <https://github.com/pypa/pip/issues/8676>`_) - Make the ``setup.py install`` deprecation warning less noisy. We warn only when ``setup.py install`` succeeded and ``setup.py bdist_wheel`` failed, as situations where both fails are most probably irrelevant to this deprecation. (`8752 <https://github.com/pypa/pip/issues/8752>`_) - Check the download directory for existing wheels to possibly avoid fetching metadata when the ``fast-deps`` feature is used with ``pip wheel`` and ``pip download``. (`8804 <https://github.com/pypa/pip/issues/8804>`_) - When installing a git URL that refers to a commit that is not available locally after git clone, attempt to fetch it from the remote. (`8815 <https://github.com/pypa/pip/issues/8815>`_) - Include http subdirectory in ``pip cache info`` and ``pip cache purge`` commands. (`8892 <https://github.com/pypa/pip/issues/8892>`_) - Cache package listings on index packages so they are guarenteed to stay stable during a pip command session. This also improves performance when a index page is accessed multiple times during the command session. (`8905 <https://github.com/pypa/pip/issues/8905>`_) - New resolver: Tweak resolution logic to improve user experience when user-supplied requirements conflict. (`8924 <https://github.com/pypa/pip/issues/8924>`_) - Support Python 3.9. (`8971 <https://github.com/pypa/pip/issues/8971>`_) - Log an informational message when backtracking takes multiple rounds on a specific package. (`8975 <https://github.com/pypa/pip/issues/8975>`_) - Switch to the new dependency resolver by default. (`9019 <https://github.com/pypa/pip/issues/9019>`_) - Remove the ``--build-dir`` option, as per the deprecation. (`9049 <https://github.com/pypa/pip/issues/9049>`_) Bug Fixes --------- - Propagate ``--extra-index-url`` from requirements file properly to session auth, so that keyring auth will work as expected. (`8103 <https://github.com/pypa/pip/issues/8103>`_) - Allow specifying verbosity and quiet level via configuration files and environment variables. Previously these options were treated as boolean values when read from there while through CLI the level can be specified. (`8578 <https://github.com/pypa/pip/issues/8578>`_) - Only converts Windows path to unicode on Python 2 to avoid regressions when a POSIX environment does not configure the file system encoding correctly. (`8658 <https://github.com/pypa/pip/issues/8658>`_) - List downloaded distributions before exiting ``pip download`` when using the new resolver to make the behavior the same as that on the legacy resolver. (`8696 <https://github.com/pypa/pip/issues/8696>`_) - New resolver: Pick up hash declarations in constraints files and use them to filter available distributions. (`8792 <https://github.com/pypa/pip/issues/8792>`_) - Avoid polluting the destination directory by resolution artifacts when the new resolver is used for ``pip download`` or ``pip wheel``. (`8827 <https://github.com/pypa/pip/issues/8827>`_) - New resolver: If a package appears multiple times in user specification with different ``--hash`` options, only hashes that present in all specifications should be allowed. (`8839 <https://github.com/pypa/pip/issues/8839>`_) - Tweak the output during dependency resolution in the new resolver. (`8861 <https://github.com/pypa/pip/issues/8861>`_) - Correctly search for installed distributions in new resolver logic in order to not miss packages (virtualenv packages from system-wide-packages for example) (`8963 <https://github.com/pypa/pip/issues/8963>`_) - Do not fail in pip freeze when encountering a ``direct_url.json`` metadata file with editable=True. Render it as a non-editable ``file://`` URL until modern editable installs are standardized and supported. (`8996 <https://github.com/pypa/pip/issues/8996>`_) Vendored Libraries ------------------ - Fix devendoring instructions to explicitly state that ``vendor.txt`` should not be removed. It is mandatory for ``pip debug`` command. Improved Documentation ---------------------- - Add documentation for '.netrc' support. (`7231 <https://github.com/pypa/pip/issues/7231>`_) - Add OS tabs for OS-specific commands. (`7311 <https://github.com/pypa/pip/issues/7311>`_) - Add note and example on keyring support for index basic-auth (`8636 <https://github.com/pypa/pip/issues/8636>`_) - Added initial UX feedback widgets to docs. (`8783 <https://github.com/pypa/pip/issues/8783>`_, `8848 <https://github.com/pypa/pip/issues/8848>`_) - Add ux documentation (`8807 <https://github.com/pypa/pip/issues/8807>`_) - Update user docs to reflect new resolver as default in 20.3. (`9044 <https://github.com/pypa/pip/issues/9044>`_) - Improve migration guide to reflect changes in new resolver behavior. (`9056 <https://github.com/pypa/pip/issues/9056>`_) ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pip - Changelog: https://pyup.io/changelogs/pip/ - Homepage: https://pip.pypa.io/ </details> Co-authored-by: pyup-bot <[email protected]>

194: Update pytest-pylint to 0.18.0 r=duckinator a=pyup-bot This PR updates [pytest-pylint](https://pypi.org/project/pytest-pylint) from **0.17.0** to **0.18.0**. *The bot wasn't able to find a changelog for this release. [Got an idea?](https://github.com/pyupio/changelogs/issues/new)* <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest-pylint - Changelog: https://pyup.io/changelogs/pytest-pylint/ - Repo: https://github.com/carsongee/pytest-pylint </details> 197: Update pip to 20.3.1 r=duckinator a=pyup-bot This PR updates [pip](https://pypi.org/project/pip) from **20.2.4** to **20.3.1**. <details> <summary>Changelog</summary> ### 20.3.1 ``` =================== Deprecations and Removals ------------------------- - The --build-dir option has been restored as a no-op, to soften the transition for tools that still used it. (`9193 <https://github.com/pypa/pip/issues/9193>`_) ``` ### 20.3 ``` - Introduce a new ResolutionImpossible error, raised when pip encounters un-satisfiable dependency conflicts (`8546 <https://github.com/pypa/pip/issues/8546>`_, `8377 <https://github.com/pypa/pip/issues/8377>`_) - Add a subcommand ``debug`` to ``pip config`` to list available configuration sources and the key-value pairs defined in them. (`6741 <https://github.com/pypa/pip/issues/6741>`_) - Warn if index pages have unexpected content-type (`6754 <https://github.com/pypa/pip/issues/6754>`_) - Allow specifying ``--prefer-binary`` option in a requirements file (`7693 <https://github.com/pypa/pip/issues/7693>`_) - Generate PEP 376 REQUESTED metadata for user supplied requirements installed by pip. (`7811 <https://github.com/pypa/pip/issues/7811>`_) - Warn if package url is a vcs or an archive url with invalid scheme (`8128 <https://github.com/pypa/pip/issues/8128>`_) - Parallelize network operations in ``pip list``. (`8504 <https://github.com/pypa/pip/issues/8504>`_) - Allow the new resolver to obtain dependency information through wheels lazily downloaded using HTTP range requests. To enable this feature, invoke ``pip`` with ``--use-feature=fast-deps``. (`8588 <https://github.com/pypa/pip/issues/8588>`_) - Support ``--use-feature`` in requirements files (`8601 <https://github.com/pypa/pip/issues/8601>`_) Bug Fixes --------- - Use canonical package names while looking up already installed packages. (`5021 <https://github.com/pypa/pip/issues/5021>`_) - Fix normalizing path on Windows when installing package on another logical disk. (`7625 <https://github.com/pypa/pip/issues/7625>`_) - The VCS commands run by pip as subprocesses don't merge stdout and stderr anymore, improving the output parsing by subsequent commands. (`7968 <https://github.com/pypa/pip/issues/7968>`_) - Correctly treat non-ASCII entry point declarations in wheels so they can be installed on Windows. (`8342 <https://github.com/pypa/pip/issues/8342>`_) - Update author email in config and tests to reflect decommissioning of pypa-dev list. (`8454 <https://github.com/pypa/pip/issues/8454>`_) - Headers provided by wheels in .data directories are now correctly installed into the user-provided locations, such as ``--prefix``, instead of the virtual environment pip is running in. (`8521 <https://github.com/pypa/pip/issues/8521>`_) Vendored Libraries ------------------ - Vendored htmlib5 no longer imports deprecated xml.etree.cElementTree on Python 3. - Upgrade appdirs to 1.4.4 - Upgrade certifi to 2020.6.20 - Upgrade distlib to 0.3.1 - Upgrade html5lib to 1.1 - Upgrade idna to 2.10 - Upgrade packaging to 20.4 - Upgrade requests to 2.24.0 - Upgrade six to 1.15.0 - Upgrade toml to 0.10.1 - Upgrade urllib3 to 1.25.9 Improved Documentation ---------------------- - Add ``--no-input`` option to pip docs (`7688 <https://github.com/pypa/pip/issues/7688>`_) - List of options supported in requirements file are extracted from source of truth, instead of being maintained manually. (`7908 <https://github.com/pypa/pip/issues/7908>`_) - Fix pip config docstring so that the subcommands render correctly in the docs (`8072 <https://github.com/pypa/pip/issues/8072>`_) - replace links to the old pypa-dev mailing list with https://mail.python.org/mailman3/lists/distutils-sig.python.org/ (`8353 <https://github.com/pypa/pip/issues/8353>`_) - Fix example for defining multiple values for options which support them (`8373 <https://github.com/pypa/pip/issues/8373>`_) - Add documentation for the ResolutionImpossible error that helps the user fix dependency conflicts (`8459 <https://github.com/pypa/pip/issues/8459>`_) - Add feature flags to docs (`8512 <https://github.com/pypa/pip/issues/8512>`_) - Document how to install package extras from git branch and source distributions. (`8576 <https://github.com/pypa/pip/issues/8576>`_) ``` ### 20.3b1 ``` =================== Deprecations and Removals ------------------------- - ``pip freeze`` will stop filtering the ``pip``, ``setuptools``, ``distribute`` and ``wheel`` packages from ``pip freeze`` output in a future version. To keep the previous behavior, users should use the new ``--exclude`` option. (`4256 <https://github.com/pypa/pip/issues/4256>`_) - Deprecate support for Python 3.5 (`8181 <https://github.com/pypa/pip/issues/8181>`_) - Document that certain removals can be fast tracked. (`8417 <https://github.com/pypa/pip/issues/8417>`_) - Document that Python versions are generally supported until PyPI usage falls below 5%. (`8927 <https://github.com/pypa/pip/issues/8927>`_) - Deprecate ``--find-links`` option in ``pip freeze`` (`9069 <https://github.com/pypa/pip/issues/9069>`_) Features -------- - Add ``--exclude`` option to ``pip freeze`` and ``pip list`` commands to explicitly exclude packages from the output. (`4256 <https://github.com/pypa/pip/issues/4256>`_) - Allow multiple values for --abi and --platform. (`6121 <https://github.com/pypa/pip/issues/6121>`_) - Add option ``--format`` to subcommand ``list`` of ``pip cache``, with ``abspath`` choice to output the full path of a wheel file. (`8355 <https://github.com/pypa/pip/issues/8355>`_) - Improve error message friendliness when an environment has packages with corrupted metadata. (`8676 <https://github.com/pypa/pip/issues/8676>`_) - Make the ``setup.py install`` deprecation warning less noisy. We warn only when ``setup.py install`` succeeded and ``setup.py bdist_wheel`` failed, as situations where both fails are most probably irrelevant to this deprecation. (`8752 <https://github.com/pypa/pip/issues/8752>`_) - Check the download directory for existing wheels to possibly avoid fetching metadata when the ``fast-deps`` feature is used with ``pip wheel`` and ``pip download``. (`8804 <https://github.com/pypa/pip/issues/8804>`_) - When installing a git URL that refers to a commit that is not available locally after git clone, attempt to fetch it from the remote. (`8815 <https://github.com/pypa/pip/issues/8815>`_) - Include http subdirectory in ``pip cache info`` and ``pip cache purge`` commands. (`8892 <https://github.com/pypa/pip/issues/8892>`_) - Cache package listings on index packages so they are guarenteed to stay stable during a pip command session. This also improves performance when a index page is accessed multiple times during the command session. (`8905 <https://github.com/pypa/pip/issues/8905>`_) - New resolver: Tweak resolution logic to improve user experience when user-supplied requirements conflict. (`8924 <https://github.com/pypa/pip/issues/8924>`_) - Support Python 3.9. (`8971 <https://github.com/pypa/pip/issues/8971>`_) - Log an informational message when backtracking takes multiple rounds on a specific package. (`8975 <https://github.com/pypa/pip/issues/8975>`_) - Switch to the new dependency resolver by default. (`9019 <https://github.com/pypa/pip/issues/9019>`_) - Remove the ``--build-dir`` option, as per the deprecation. (`9049 <https://github.com/pypa/pip/issues/9049>`_) Bug Fixes --------- - Propagate ``--extra-index-url`` from requirements file properly to session auth, so that keyring auth will work as expected. (`8103 <https://github.com/pypa/pip/issues/8103>`_) - Allow specifying verbosity and quiet level via configuration files and environment variables. Previously these options were treated as boolean values when read from there while through CLI the level can be specified. (`8578 <https://github.com/pypa/pip/issues/8578>`_) - Only converts Windows path to unicode on Python 2 to avoid regressions when a POSIX environment does not configure the file system encoding correctly. (`8658 <https://github.com/pypa/pip/issues/8658>`_) - List downloaded distributions before exiting ``pip download`` when using the new resolver to make the behavior the same as that on the legacy resolver. (`8696 <https://github.com/pypa/pip/issues/8696>`_) - New resolver: Pick up hash declarations in constraints files and use them to filter available distributions. (`8792 <https://github.com/pypa/pip/issues/8792>`_) - Avoid polluting the destination directory by resolution artifacts when the new resolver is used for ``pip download`` or ``pip wheel``. (`8827 <https://github.com/pypa/pip/issues/8827>`_) - New resolver: If a package appears multiple times in user specification with different ``--hash`` options, only hashes that present in all specifications should be allowed. (`8839 <https://github.com/pypa/pip/issues/8839>`_) - Tweak the output during dependency resolution in the new resolver. (`8861 <https://github.com/pypa/pip/issues/8861>`_) - Correctly search for installed distributions in new resolver logic in order to not miss packages (virtualenv packages from system-wide-packages for example) (`8963 <https://github.com/pypa/pip/issues/8963>`_) - Do not fail in pip freeze when encountering a ``direct_url.json`` metadata file with editable=True. Render it as a non-editable ``file://`` URL until modern editable installs are standardized and supported. (`8996 <https://github.com/pypa/pip/issues/8996>`_) Vendored Libraries ------------------ - Fix devendoring instructions to explicitly state that ``vendor.txt`` should not be removed. It is mandatory for ``pip debug`` command. Improved Documentation ---------------------- - Add documentation for '.netrc' support. (`7231 <https://github.com/pypa/pip/issues/7231>`_) - Add OS tabs for OS-specific commands. (`7311 <https://github.com/pypa/pip/issues/7311>`_) - Add note and example on keyring support for index basic-auth (`8636 <https://github.com/pypa/pip/issues/8636>`_) - Added initial UX feedback widgets to docs. (`8783 <https://github.com/pypa/pip/issues/8783>`_, `8848 <https://github.com/pypa/pip/issues/8848>`_) - Add ux documentation (`8807 <https://github.com/pypa/pip/issues/8807>`_) - Update user docs to reflect new resolver as default in 20.3. (`9044 <https://github.com/pypa/pip/issues/9044>`_) - Improve migration guide to reflect changes in new resolver behavior. (`9056 <https://github.com/pypa/pip/issues/9056>`_) ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pip - Changelog: https://pyup.io/changelogs/pip/ - Homepage: https://pip.pypa.io/ </details> Co-authored-by: pyup-bot <[email protected]> Co-authored-by: Ellen Marie Dash <[email protected]>

webknjaz mentioned this pull request Sep 5, 2020

Add email link on pip's documentation #8783

Closed

webknjaz added a commit to webknjaz/pip that referenced this pull request Sep 5, 2020

Add a change fragment about issue pypa#8783 / PR pypa#8848

dd2cbf8

webknjaz added a commit to webknjaz/pip that referenced this pull request Sep 5, 2020

Add a change fragment about issue pypa#8783 / PR pypa#8848

db86ae8

webknjaz force-pushed the features/8783--sphinx-ext-admonitions branch 2 times, most recently from 7c1453e to 43026db Compare September 5, 2020 22:07

webknjaz marked this pull request as ready for review September 5, 2020 22:07

webknjaz force-pushed the features/8783--sphinx-ext-admonitions branch from 43026db to 9faa369 Compare September 5, 2020 22:08

webknjaz commented Sep 5, 2020

View reviewed changes

news/8848.doc Show resolved Hide resolved

McSinyx reviewed Sep 6, 2020

View reviewed changes

Add a change fragment about issue pypa#8783 / PR pypa#8848

67bff61

webknjaz force-pushed the features/8783--sphinx-ext-admonitions branch from 9faa369 to 87f1017 Compare September 25, 2020 21:16

webknjaz requested review from pradyunsg and pfmoore September 25, 2020 21:16

webknjaz added 2 commits September 25, 2020 23:25

📝 Add initial sphinx ext for per-doc feedbacks

3301284

Resolves pypa#8783

🎨 Colorize the "important" admonition blocks

13962cd

webknjaz force-pushed the features/8783--sphinx-ext-admonitions branch from 87f1017 to 13962cd Compare September 25, 2020 21:25

pradyunsg approved these changes Sep 27, 2020

View reviewed changes

pradyunsg merged commit fe2075b into pypa:master Sep 30, 2020

github-actions bot locked as resolved and limited conversation to collaborators Oct 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📝 Add initial sphinx ext for per-doc feedbacks #8848

📝 Add initial sphinx ext for per-doc feedbacks #8848

webknjaz commented Sep 5, 2020

pradyunsg commented Sep 5, 2020

webknjaz commented Sep 5, 2020 •

edited

Loading

webknjaz commented Sep 5, 2020

jdittrich commented Sep 6, 2020

McSinyx Sep 6, 2020 •

edited

Loading

webknjaz Sep 6, 2020

pradyunsg Sep 7, 2020

McSinyx Sep 7, 2020

pfmoore commented Sep 6, 2020

pradyunsg commented Sep 6, 2020

webknjaz commented Sep 6, 2020

webknjaz commented Sep 6, 2020

webknjaz commented Sep 6, 2020

jdittrich commented Sep 7, 2020

webknjaz commented Sep 7, 2020

webknjaz commented Sep 25, 2020 •

edited

Loading

pradyunsg commented Sep 27, 2020

nlhkabu commented Sep 27, 2020

jdittrich commented Sep 29, 2020

📝 Add initial sphinx ext for per-doc feedbacks #8848

📝 Add initial sphinx ext for per-doc feedbacks #8848

Conversation

webknjaz commented Sep 5, 2020

pradyunsg commented Sep 5, 2020

webknjaz commented Sep 5, 2020 • edited Loading

webknjaz commented Sep 5, 2020

jdittrich commented Sep 6, 2020

McSinyx Sep 6, 2020 • edited Loading

Choose a reason for hiding this comment

webknjaz Sep 6, 2020

Choose a reason for hiding this comment

pradyunsg Sep 7, 2020

Choose a reason for hiding this comment

McSinyx Sep 7, 2020

Choose a reason for hiding this comment

pfmoore commented Sep 6, 2020

pradyunsg commented Sep 6, 2020

webknjaz commented Sep 6, 2020

webknjaz commented Sep 6, 2020

webknjaz commented Sep 6, 2020

jdittrich commented Sep 7, 2020

webknjaz commented Sep 7, 2020

webknjaz commented Sep 25, 2020 • edited Loading

pradyunsg commented Sep 27, 2020

nlhkabu commented Sep 27, 2020

jdittrich commented Sep 29, 2020

webknjaz commented Sep 5, 2020 •

edited

Loading

McSinyx Sep 6, 2020 •

edited

Loading

webknjaz commented Sep 25, 2020 •

edited

Loading