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

📚🩹 Use fixed pydata-sphinx-theme from fork #334

Merged
merged 3 commits into from
Mar 1, 2025

Conversation

s-weigand
Copy link
Member

@s-weigand s-weigand commented Mar 1, 2025

Today I found that our docs are broken due to a bug when building PDFs.

This PR changes the pydata-sphinx-theme from the published upstream project to a branch on my for including the following fixes:

I also went ahead and removed the workaround on our side since it isn't needed with the fix on my fork in place.

Change summary

Checklist

  • ✔️ Passing the tests (mandatory for all PR's)

Summary by Sourcery

Bug Fixes:

  • Fixes a bug in pydata-sphinx-theme that was breaking the documentation build.

@s-weigand s-weigand requested a review from a team as a code owner March 1, 2025 19:39
Copy link
Contributor

sourcery-ai bot commented Mar 1, 2025

Reviewer's Guide by Sourcery

This pull request addresses a PDF building issue by switching to a forked version of pydata-sphinx-theme that includes necessary fixes. It also removes a related workaround that is no longer required.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Switched to a forked version of pydata-sphinx-theme to address PDF build issues.
  • Updated the dependency to point to a specific branch in a fork of pydata-sphinx-theme.
  • This includes fixes from PR #2097 and #2076 in the upstream repository.
requirements_pinned.txt
Removed a workaround related to pydata-sphinx-theme version 0.16.1.
  • Removed the code that creates a directory to avoid errors during link checking.
  • This workaround is no longer needed due to the fixes included in the forked pydata-sphinx-theme.
docs/conf.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

jsnel
jsnel previously approved these changes Mar 1, 2025
Copy link
Member

@jsnel jsnel left a comment

Choose a reason for hiding this comment

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

Thanks for the quick fix!

Copy link

codecov bot commented Mar 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.04%. Comparing base (bb362ce) to head (a8ca255).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #334   +/-   ##
=======================================
  Coverage   58.04%   58.04%           
=======================================
  Files          31       31           
  Lines        1616     1616           
  Branches      213      213           
=======================================
  Hits          938      938           
  Misses        660      660           
  Partials       18       18           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@jsnel jsnel left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the build env as well. :)

@s-weigand s-weigand merged commit caec58b into glotaran:main Mar 1, 2025
31 checks passed
@s-weigand s-weigand deleted the fix-docs branch March 1, 2025 20:27
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