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

PEPs.docset 2024.08.30 #5127

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docsets/PEPs/PEPs.tgz
Binary file not shown.
7 changes: 3 additions & 4 deletions docsets/PEPs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ This docset contains all PEPs from the Python Software Foundation.
## Building the docset

1. Clone the [PEPs repository](https://github.com/python/peps)
2. Follow the build instructions. As of 2023.01.28, you need to
`pip install -r requirements.txt` and `make render`.
2. Follow the build instructions. As of 2024.08.30, you need to `make html`.
3. Install [`doc2dash`](https://pypi.org/project/doc2dash/).
4. Build Docset from built HTML:

Expand All @@ -16,8 +15,8 @@ doc2dash --index-page index.html --icon build/_static/py.png --online-redirect-u

## Hiccups

The [`:pep:` Sphinx role typically generates a hyperlink to the PEPs website](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-pep),
The [`:pep:` Sphinx role typically generates a hyperlink to the PEPs website](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-pep),
but when buliding the PEPs documentation locally we'd like it to link to relative
pages. Indeed, the PEP repository overrides this role to provide this behaviour,
but until [PR #2972](https://github.com/python/peps/pull/2972) it was linking to
an absolute path which broke internal links when browsing locally.
an absolute path which broke internal links when browsing locally.
4 changes: 2 additions & 2 deletions docsets/PEPs/docset.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Python Enhancement Proposals",
"version": "2023.01.28",
"version": "2024.08.30",
"archive": "PEPs.tgz",
"author": {
"name": "Warren Alphonso",
Expand All @@ -10,4 +10,4 @@
"PEP",
"PEPs"
]
}
}
Loading