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.

Sign up for GitHub

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 9 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
acdcf1c
feat: intergrate sphinx-issues to replace extlinks
shenxianpeng Apr 8, 2024
e6923fb
Add news file 12551.trivial.rst
shenxianpeng Apr 9, 2024
1f5117f
Merge branch 'main' into replace-extlinks
shenxianpeng Apr 9, 2024
9ea3eb4
fix: add pypi back and replaced pull to pr
shenxianpeng Apr 9, 2024
8261b3d
fix(config.py): revert formatting
shenxianpeng Apr 10, 2024
ee30e2f
removed extlinks for pypi
shenxianpeng Apr 15, 2024
babf447
Drop sphinx.ext.extlinks from extensions
shenxianpeng Apr 27, 2024
7a5ddfc
move the new option to sphinx_issues section
shenxianpeng Jul 14, 2024
51e4b38
keep the same number of line strings
shenxianpeng Jul 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions NEWS.rst
View file
Open in desktop
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
14 changes: 5 additions & 9 deletions docs/html/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
# first-party extensions
"sphinx.ext.autodoc",
"sphinx.ext.todo",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
# our extensions
"pip_sphinxext",
Expand All @@ -26,6 +25,7 @@
"sphinx_copybutton",
"sphinx_inline_tabs",
"sphinxcontrib.towncrier",
"sphinx_issues",
]

# General information about the project.
Expand Down Expand Up @@ -71,14 +71,6 @@
"pypug": ("https://packaging.python.org", None),
}

# -- 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"),
}

# -- Options for towncrier_draft extension --------------------------------------------

towncrier_draft_autoversion_mode = "draft" # or: 'sphinx-release', 'sphinx-version'
Expand Down Expand Up @@ -137,3 +129,7 @@ def to_document_name(path: str, base_dir: str) -> str:
copybutton_prompt_text = r"\$ | C\:\> "
copybutton_prompt_is_regexp = True
copybutton_only_copy_prompt_lines = False

# -- Options for sphinx_issues --------------------------------------------------------

issues_default_group_project = "pypa/pip"
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
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
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, trivial fragments aren't displayed anywhere, and their content is disregarded. The contribution guidelines state that they should be empty (but this isn't linted for some reason). This is a way to fool the checks, but it doesn't let one actually tell the end-users what's happened/changed.

I believe that once #12853 is in, it'll be possible to move this to one of packaging/contrib/misc if desired.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Integrate ``sphinx-issues`` into the Sphinx config.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, if it's decided that this should go to a change log, it should probably link the integrated project with a hyperlink.

Loading