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

Refactor navbar generating function #1780

Merged
merged 4 commits into from
May 22, 2024
Merged

Conversation

Carreau
Copy link
Collaborator

@Carreau Carreau commented Apr 23, 2024

Should fix #1773

This try to split the function into two parts: one that wrangle the
data, one that generate html.

The generating the data part should be cacheable, while the other can be
made more flexible to be reusable in different part of the theme
(typically generating or not dropdowns in the sidebar or navbar).

@Carreau Carreau force-pushed the link-toc-refactor branch from 5cb634f to faa8b74 Compare May 2, 2024 09:10
@trallard trallard added the tag: component Issues or improvements associated with a given component in the theme label May 7, 2024
@Carreau Carreau force-pushed the link-toc-refactor branch from faa8b74 to 1418634 Compare May 7, 2024 12:24
Carreau added 2 commits May 14, 2024 14:09
On top of  pydata#1771, should fix pydata#1773 (once fininished)

This try to split the function into two parts: one that wrangle the
data,  one that generate html.

The generating the data part should be cacheable, while the other can be
made more flexible to be reusable in different part of the theme
(typically generating or not dropdowns in the sidebar or navbar).
@Carreau Carreau force-pushed the link-toc-refactor branch from 1418634 to 2990818 Compare May 14, 2024 12:09
@Carreau Carreau force-pushed the link-toc-refactor branch from 2990818 to 25e1549 Compare May 14, 2024 12:19
Copy link

github-actions bot commented May 14, 2024

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  src/pydata_sphinx_theme
  toctree.py 215-216
Project Total  

This report was generated by python-coverage-comment-action

@Carreau Carreau marked this pull request as ready for review May 14, 2024 12:39
@Carreau Carreau changed the title DRAFT: Refactor navbar generating function Refactor navbar generating function May 15, 2024
Copy link
Collaborator

@drammock drammock left a comment

Choose a reason for hiding this comment

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

@Carreau I pushed some small cleanups in b5bcb67

If you're happy with them feel free to merge when green

@Carreau Carreau merged commit 56ceeab into pydata:main May 22, 2024
18 checks passed
@Carreau Carreau deleted the link-toc-refactor branch May 22, 2024 08:08
ivanov pushed a commit to ivanov/pydata-sphinx-theme that referenced this pull request Jun 5, 2024
Refactor navbar generating function.

This should fix pydata#1773 (once fininished)

It tries to split the function into two parts: one that wrangle the
data,  one that generate html.

The generating the data part should be cacheable, while the other can be
made more flexible to be reusable in different part of the theme
(typically generating or not dropdowns in the sidebar or navbar).
---------

Co-authored-by: Daniel McCloy <dan@mccloy.info>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag: component Issues or improvements associated with a given component in the theme
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split and refactor generate_header_nav_before_dropdown
3 participants