-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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
Conversation
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? |
A few thoughts:
What do you think? |
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> |
There was a problem hiding this comment.
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.
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. |
How about putting a link to the NEPs in the navigation bar - that is quite prominent and of course visible on every page. |
@rossbar I am ok with that solution as well, but here's how it looks locally: We would need to either customize the width of the navbar or remove some other item, I'm afraid... |
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... |
Ok - it's easier than I realized! Here's the NEPs link in the top navbar: |
80f7316
to
34b7f1b
Compare
[skip azp] [skip travis] [skip cirrus]
Looks good. Thanks, Melissa! |
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.