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

Infra: Move numerical index to own page #3992

Merged
merged 6 commits into from
Sep 26, 2024
Merged

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Sep 24, 2024

Fixes #2044.

Re: #2044 (comment)

The frontpage index (PEP 0) is very long, and starts the PEPs grouped by category, followed by a big table sorted by number.

This duplicates the PEP list (there's 655 right now), and can make searching in the page a bit confusing.

This PR creates a new numerical.html page with the numerical index.

I've kept the "Numerical Index" header on the frontpage and added a link to the new page. I moved the header up, before the remaining groups, but don't have a strong opinion on where this should be.


📚 Documentation preview 📚: https://pep-previews--3992.org.readthedocs.build/numerical/

@hugovk hugovk added the infra Core infrastructure for building and rendering PEPs label Sep 24, 2024
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

I love this @hugovk. Great usability improvement.

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Pushed one commit to remove the source link, GH review limitations etc etc.

A

pep_sphinx_extensions/pep_zero_generator/writer.py Outdated Show resolved Hide resolved
peps/contents.rst Outdated Show resolved Hide resolved
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk
Copy link
Member Author

hugovk commented Sep 25, 2024

Thanks both for the reviews!

We now have an empty Contents sidebar:

image

We could remove the header, but some of the titles and author lists are pretty long, so shall we instead let this table be wider? Something like:

image

@AA-Turner
Copy link
Member

so shall we instead let this table be wider

I'd perhaps left-align to where the sidebar is (was), but I would hesistate to make the table much wider than 60-64em (~900-950px), as it becomes difficult to read. For reference, GitHub's central area has a width of ~830px, and Wikipedia's new 'Standard' design has a width of ~950px.

A

@AA-Turner
Copy link
Member

AA-Turner commented Sep 25, 2024

In local tests I used:

nav#pep-sidebar {
    display: none;
}
@media (min-width: 40em) {
    section#pep-page-section > article {
        width: 85%;
        float: unset;
    }
}
@media (min-width: 60em) {
    section#pep-page-section > article {
        max-width: 62em;
    }
}

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk
Copy link
Member Author

hugovk commented Sep 26, 2024

I had a go with that but the table of contents showed at the bottom of the page for PEP 0 and actual PEPs.

How does e439e06 look?

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner merged commit 24552ca into python:main Sep 26, 2024
23 checks passed
@hugovk hugovk deleted the numerical-index branch September 26, 2024 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Core infrastructure for building and rendering PEPs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Date order on main page?
3 participants