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

🩹📚 Fix search in docs #157

Merged
merged 2 commits into from
Mar 20, 2023
Merged

Conversation

s-weigand
Copy link
Member

@s-weigand s-weigand commented Mar 20, 2023

Currently, the search functionality in our docs hangs indefinitely.
The error you get in the dev tools console is

Uncaught ReferenceError: jQuery is not defined

This relates to a change in the rtd theme and how to use it (old config).

Change summary

Checklist

  • ✔️ Passing the tests (mandatory for all PR's)
  • 👌 Closes issue (mandatory for ✨ feature and 🩹 bug fix PR's)

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 20, 2023

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.12%.

Quality metrics Before After Change
Complexity 0.00 ⭐ 0.00 ⭐ 0.00
Method Length 119.00 🙂 120.00 😞 1.00 👎
Working memory 5.00 ⭐ 5.00 ⭐ 0.00
Quality 78.15% 78.03% -0.12% 👎
Other metrics Before After Change
Lines 155 156 1
Changed files Quality Before Quality After Quality Change
docs/conf.py 78.15% ⭐ 78.03% ⭐ -0.12% 👎

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@github-actions
Copy link
Contributor

Binder 👈 Launch a binder notebook on branch s-weigand/pyglotaran-extras/fix-docs-search

@s-weigand s-weigand marked this pull request as ready for review March 20, 2023 21:35
@s-weigand s-weigand requested a review from a team as a code owner March 20, 2023 21:35
@s-weigand
Copy link
Member Author

Search works again try it out

@codecov
Copy link

codecov bot commented Mar 20, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (977ad84) 44.79% compared to head (c8925e1) 44.79%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #157   +/-   ##
=======================================
  Coverage   44.79%   44.79%           
=======================================
  Files          29       29           
  Lines         942      942           
  Branches      134      134           
=======================================
  Hits          422      422           
  Misses        513      513           
  Partials        7        7           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@s-weigand s-weigand merged commit 9962351 into glotaran:main Mar 20, 2023
@s-weigand s-weigand deleted the fix-docs-search branch March 20, 2023 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants