Skip to content

Fix links to spec schemas #1910

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix links to spec schemas #1910

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3669181
Fix links to spec schemas
edgarrmondragon Sep 13, 2025
646e61b
Merge branch 'main' into fix-schema-links
edgarrmondragon Oct 9, 2025
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
0 ...ns/schemas/build-details-v1.0.schema.json → ...ns/schemas/build-details-v1.0.schema.json
View file
Open in desktop
File renamed without changes.
0 ...ifications/schemas/direct-url.schema.json → ...ifications/schemas/direct-url.schema.json
View file
Open in desktop
File renamed without changes.
0 ...specifications/schemas/pylock.schema.json → ...specifications/schemas/pylock.schema.json
View file
Open in desktop
File renamed without changes.
7 changes: 7 additions & 0 deletions source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@
# https://plausible.io/packaging.python.org
html_js_files.extend(_metrics_js_files)

html_extra_path = [
"../extra",
]

# -- Options for HTML help output ------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-help-output

Expand Down Expand Up @@ -157,6 +161,9 @@
# https://github.com/pypa/packaging.python.org/issues/1744
r"https://pypi\.org/",
]
linkcheck_exclude_documents = [
"specifications/schemas/index",
]
Comment on lines +165 to +167
Copy link
Contributor Author

@edgarrmondragon edgarrmondragon Sep 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I added this to skip checking the links to the schema files

Outdated comment about broken npmjs link

but now https://www.npmjs.com/ is returning a 403

https://github.com/pypa/packaging.python.org/actions/runs/17874520027/job/50833970948?pr=1910#step:5:1022

Fixed by #1928.


# -- Options for extlinks ----------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#configuration
Expand Down
2 changes: 1 addition & 1 deletion source/specifications/build-details/v1.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Specification
-------------

.. jsonschema:: ../schemas/build-details-v1.0.schema.json
.. jsonschema:: ../../../extra/specifications/schemas/build-details-v1.0.schema.json
:lift_title: false


Expand Down
2 changes: 1 addition & 1 deletion source/specifications/direct-url-data-structure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ JSON Schema

The following JSON Schema can be used to validate the contents of ``direct_url.json``:

.. literalinclude:: schemas/direct-url.schema.json
.. literalinclude:: ../../extra/specifications/schemas/direct-url.schema.json

Examples
========
Expand Down
Loading