Skip to content

Doc: improve static search speed and fix missing module icons #1971

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

Merged
merged 2 commits into from
Dec 18, 2024

Conversation

moe-ad
Copy link
Contributor

@moe-ad moe-ad commented Dec 18, 2024

This PR will close #1970. It adds html theme option to improve static search live preview performance. It also fixes the problem of missing module icons in the section navigation of the api documentation.

Verified

This commit was signed with the committer’s verified signature.
JamesNK James Newton-King
@moe-ad moe-ad self-assigned this Dec 18, 2024
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

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

Excellent, @moe-ad. I hope you used a script to automate this.

Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.37%. Comparing base (4fcf544) to head (e6b9b61).
Report is 30 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1971      +/-   ##
==========================================
- Coverage   88.47%   88.37%   -0.11%     
==========================================
  Files          89       89              
  Lines       10251    10251              
==========================================
- Hits         9070     9059      -11     
- Misses       1181     1192      +11     

@moe-ad
Copy link
Contributor Author

moe-ad commented Dec 18, 2024

Yes. I used a python script for the task.

@moe-ad moe-ad marked this pull request as ready for review December 18, 2024 09:26

Verified

This commit was signed with the committer’s verified signature.
JamesNK James Newton-King
@jorgepiloto
Copy link
Member

No worries about the doc-style action. It fails for big diff PRs.

@jorgepiloto jorgepiloto merged commit c133af5 into master Dec 18, 2024
44 of 45 checks passed
@jorgepiloto jorgepiloto deleted the doc/improve-api-documentation branch December 18, 2024 10:50
@@ -1,6 +1,6 @@
"""
elemental_difference
====================
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @moe-ad, everything under operators/ is generated automatically using a template. We'll need to update the template for this to stay that way.

Copy link
Contributor

@PProfizi PProfizi Jan 2, 2025

Choose a reason for hiding this comment

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

See here and here

@PProfizi PProfizi added the documentation Improvements or additions to documentation label Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve static search live preview performance and fix missing module icons in the api documentation
3 participants