Skip to content

DOC: Proposal - make the doc landing page cards more similar to scipy#21491

Merged
charris merged 5 commits intonumpy:mainfrom
rossbar:doc/sync-frontpage-scipy
May 14, 2022
Merged

DOC: Proposal - make the doc landing page cards more similar to scipy#21491
charris merged 5 commits intonumpy:mainfrom
rossbar:doc/sync-frontpage-scipy

Conversation

@rossbar
Copy link
Copy Markdown
Contributor

@rossbar rossbar commented May 11, 2022

This was discussed in the docs meeting and builds on #21456 . The proposal is to make the docs landing page look more like the pandas and scipy landing pages. The landing pages for these three projects already borrow heavily from one another - this PR just makes a few tweaks to bring numpy more in line stylistically with the other two. Main changes:

  • Match the card styling by dropping the card title background color and adding a button in the same style as scipy/pandas
  • Adds a link to the release notes to the top-level nav bar

There's also one minor maintenance issue: we're currently loading the custom css by extending the main layout template. AFAICT that is the only purpose that extending the layout template currently serves (the other additions have been commented out - see #17220). I think it's more straightforward to use the sphinx html_css_files config value to accomplish this rather than loading the css in the base template. I've made that change in 08ae8d3 but if there are objections I'm happy to break that out into a separate PR.

Also fixes #21264

Co-authored-by: Stefan van der Walt <stefanv@berkeley.edu>
Copy link
Copy Markdown
Member

@seberg seberg left a comment

Choose a reason for hiding this comment

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

I think the changes are a pretty nice improvement. Especially, the fact that we uninentionally had a smaller width on all of the docs because of htat one small setting ;).
@melissawm, I guess this was good to just be merged?

@charris
Copy link
Copy Markdown
Member

charris commented May 14, 2022

Thanks Ross. Should (can) this be backported? I'm going to rebuild the 1.22 docs for 1.22.4.

@rossbar
Copy link
Copy Markdown
Contributor Author

rossbar commented May 15, 2022

Thanks Ross. Should (can) this be backported? I'm going to rebuild the 1.22 docs for 1.22.4.

Yes I think this should be backported - it'd be nice to have consistent theming for the 1.22 and 1.23 docs. There shouldn't be any problems backporting, but I'll keep an eye on the CI of the backport PR!

@rossbar rossbar added the 09 - Backport-Candidate PRs tagged should be backported label May 15, 2022
charris pushed a commit to charris/numpy that referenced this pull request May 15, 2022
…/pandas (numpy#21491)

* DOC: Add panel elements to index matching scipy/pandas.

* DOC: Update card styling in css to match scipy/pandas.

* DOC: Add release notes to nav bar.

* DOC: replace css in layout with html_css_files conf val.

* DOC: Fix page layout.

Co-authored-by: Stefan van der Walt <stefanv@berkeley.edu>

Co-authored-by: Stefan van der Walt <stefanv@berkeley.edu>
@charris charris changed the title DOC: Proposal - make the doc landing page cards more similar to scipy/pandas DOC: Proposal - make the doc landing page cards more similar to scipy May 15, 2022
@charris charris removed the 09 - Backport-Candidate PRs tagged should be backported label May 15, 2022
@chrisjsewell
Copy link
Copy Markdown

Hey @rossbar 👋
just to mention, I deprecated sphinx-panels for sphinx-design a little while ago.
Here are some pointers on migrating: https://sphinx-design.readthedocs.io/en/furo-theme/get_started.html#migrating-from-sphinx-panels, and also in executablebooks/sphinx-design#51

You can also see it in action now on the front page of https://myst-parser.readthedocs.io, https://myst-nb.readthedocs.io, and https://aiida.readthedocs.io

Obviously, feedback is also welcome 😄

@rossbar
Copy link
Copy Markdown
Contributor Author

rossbar commented May 16, 2022

Thanks for the heads up @chrisjsewell !

The goal here is to stay coordinated with the card-layout on the front page of scipy & pandas - it'd be nice to coordinate the transition or synchronize once one of the projects migrates. Pinging @tupui and @jorisvandenbossche just so it's on some radars.

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.

DOC: Sidebars are not pinned on the numpy docs site

4 participants