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

remove unneeded sphinxcontrib extension - sphinxcontrib.jquery #2047

Merged
merged 5 commits into from
May 23, 2023

Conversation

valeriupredoi
Copy link
Contributor

@valeriupredoi valeriupredoi commented May 19, 2023

Description

Following @bouweandela 's suggestion to get rid of that extension, since we have a new sphinx theme now.

Closes #2035

Link to documentation: example of docs built correctly and search working well (for "cmip" keyword) here


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.


To help with the number pull requests:

@valeriupredoi valeriupredoi added the documentation Improvements or additions to documentation label May 19, 2023
@valeriupredoi valeriupredoi requested a review from bouweandela May 19, 2023 12:12
@codecov
Copy link

codecov bot commented May 19, 2023

Codecov Report

Merging #2047 (5ba85a0) into main (64f7c0f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2047   +/-   ##
=======================================
  Coverage   92.79%   92.79%           
=======================================
  Files         236      236           
  Lines       12484    12484           
=======================================
  Hits        11585    11585           
  Misses        899      899           

@valeriupredoi
Copy link
Contributor Author

@bouweandela you were right! Docs build well at Readthedocs and search works just fine too, without the extension - however, docs build fails with something I got no clue about on Circle (install works fine though) - help! also @zklaus

@valeriupredoi
Copy link
Contributor Author

@bouweandela you remember that pointer you gave me how to fix the current fail? Beats me if I can find it anywhere, could you repost plsss 🍺

@bouweandela
Copy link
Member

bouweandela commented May 23, 2023

You could try adding :no-inherited-members: to the problematic class

@valeriupredoi
Copy link
Contributor Author

You could try adding :no-inherited-members: to the problematic class

ah that was the one, thanks, man! 🍺

@valeriupredoi
Copy link
Contributor Author

@bouweandela that worked smoother than a baby's bottom, cheers 🍺 Can I haz a review pls?

Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

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

Looks good! If you could clean up please, then I can approve.

@valeriupredoi
Copy link
Contributor Author

cheers, bud 🍺

@valeriupredoi valeriupredoi merged commit de55eb4 into main May 23, 2023
@valeriupredoi valeriupredoi deleted the remove_sphinxcontrib-jquery_extension branch May 23, 2023 14:17
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.

CircleCI build documentation fails - need sphinxcontrib.jquery
2 participants