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

DOC: Add link to NEPs in top navbar #24029

Merged
merged 1 commit into from
Jun 29, 2023
Merged

Conversation

melissawm
Copy link
Member

From numpy.org it is not obvious how to get to the NEPs page. Unless you know the number of a specific NEP or know the URL, there are no (obvious) links pointing to them. This PR adds a link to the NEPs index from the main User Guide menu.

This may not be the best place to link, better suggestions are welcome.

@charris
Copy link
Member

charris commented Jun 23, 2023

I agree that NEPs need to be more visible, but this still seems a bit hidden. Is there a higher level where they could be linked?

@melissawm
Copy link
Member Author

melissawm commented Jun 23, 2023

A few thoughts:

  1. We could have a link to the neps from the "Useful links" rubric on https://numpy.org/devdocs/index.html (I'd maybe do this regardless of where the other link lives)
  2. I think the NEPs are probably more relevant to developers and to anyone checking the API reference than users, so one idea would be to move it out of the user guide and link it at the bottom of the toc on https://numpy.org/devdocs/reference/index.html and/or https://numpy.org/devdocs/dev/index.html
  3. Another thought: Have the "Extras" section of the toc from the user guide be a sidebar element, so that it shows at the bottom of the left sidebar on all sections. One could argue that the glossary, license, release notes and NEPs are relevant enough to be there in all pages.

What do you think?

@melissawm
Copy link
Member Author

For item 3, here's what I mean: https://output.circle-artifacts.com/output/job/1d120789-bcdc-47c0-8670-d819e5a38f02/artifacts/0/doc/build/html/index.html

(for a final version I'll remove it from the main landing page)


<li class="toctree-l1"><a class="reference internal" href="../license.html">NumPy license</a></li>

<li class="toctree-l1"><a class="reference internal" href="https: //numpy.org/neps">NumPy Enhancement Proposals (NEPs)</a></li>
Copy link
Member

Choose a reason for hiding this comment

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

Is the space between : and // intended? It seems to work, but is somewhat unusual. None of the links work in the circleci generated document, but that is probably unrelated.

@seberg
Copy link
Member

seberg commented Jun 26, 2023

That last version looks good to me, I suspect it could be more prominent, but I can't think of a better place. I could see adding them as text on the landing page since we already have links to the old docs, etc. but not sure and no need to do it here.

@rossbar
Copy link
Contributor

rossbar commented Jun 27, 2023

How about putting a link to the NEPs in the navigation bar - that is quite prominent and of course visible on every page.

@melissawm
Copy link
Member Author

@rossbar I am ok with that solution as well, but here's how it looks locally:

Screenshot_20230627_101535

We would need to either customize the width of the navbar or remove some other item, I'm afraid...

@rossbar
Copy link
Contributor

rossbar commented Jun 27, 2023

We would need to either customize the width of the navbar

I'd vote for this - other projects (e.g. scipy, networkx) have both more and longer items in the navbar, and I think we have plenty of room without it looking cluttered! Then again, I don't know exactly what we'd need to do to get the theme configured the way we want...

@melissawm
Copy link
Member Author

melissawm commented Jun 27, 2023

Ok - it's easier than I realized! Here's the NEPs link in the top navbar:

https://output.circle-artifacts.com/output/job/1372f4dd-eccd-40d9-9b5f-21311b4aa94b/artifacts/0/doc/build/html/index.html

@melissawm melissawm force-pushed the add-neps branch 2 times, most recently from 80f7316 to 34b7f1b Compare June 27, 2023 21:23
[skip azp] [skip travis] [skip cirrus]
@melissawm melissawm changed the title DOC: Add link to NEPs index from user guide DOC: Add link to NEPs in top navbar Jun 27, 2023
@Mukulikaa
Copy link
Contributor

Looks good. Thanks, Melissa!

@Mukulikaa Mukulikaa merged commit b052950 into numpy:main Jun 29, 2023
48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants