Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Integrate sphinx-issues into the Sphinx config #12616

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3100,7 +3100,7 @@ Improved Documentation
- Upgrade the bundled copy of requests to 2.6.0, fixing CVE-2015-2296.
- Display format of latest package when using ``pip list --outdated``. (#2475)
- Don't use pywin32 as ctypes should always be available on Windows, using
pywin32 prevented uninstallation of pywin32 on Windows. (:pull:`2467`)
pywin32 prevented uninstallation of pywin32 on Windows. (:pr:`2467`)
- Normalize the ``--wheel-dir`` option, expanding out constructs such as ``~``
when used. (#2441)
- Display a warning when an undefined extra has been requested. (#2142)
Expand Down Expand Up @@ -3391,7 +3391,7 @@ Improved Documentation
--no-download`` are now formally deprecated. See #906 for discussion on
possible alternatives, or lack thereof, in future releases.
- **DEPRECATION** ``pip zip`` and ``pip unzip`` are now formally deprecated.
- pip will now install Mac OSX platform wheels from PyPI. (:pull:`1278`)
- pip will now install Mac OSX platform wheels from PyPI. (:pr:`1278`)
- pip now generates the appropriate platform-specific console scripts when
installing wheels. (#1251)
- pip now confirms a wheel is supported when installing directly from a path or
Expand Down
4 changes: 2 additions & 2 deletions docs/html/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@
"sphinx_copybutton",
"sphinx_inline_tabs",
"sphinxcontrib.towncrier",
"sphinx_issues",
]

# General information about the project.
project = "pip"
copyright = "The pip developers"
issues_default_group_project = "pypa/pip"

# Find the version and release information.
# We have a single source of truth for our version number: pip's __init__.py file.
Expand Down Expand Up @@ -74,8 +76,6 @@
# -- Options for extlinks -------------------------------------------------------------

shenxianpeng marked this conversation as resolved.
Show resolved Hide resolved
extlinks = {
"issue": ("https://github.com/pypa/pip/issues/%s", "#%s"),
"pull": ("https://github.com/pypa/pip/pull/%s", "PR #%s"),
"pypi": ("https://pypi.org/project/%s/", "%s"),
}

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ myst_parser
sphinx-copybutton
sphinx-inline-tabs
sphinxcontrib-towncrier >= 0.2.0a0
sphinx-issues

# `docs.pipext` uses pip's internals to generate documentation. So, we install
# the current directory to make it work.
Expand Down
1 change: 1 addition & 0 deletions news/12551.trivial.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Integrate ``sphinx-issues`` into the Sphinx config.