Skip to content

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented May 8, 2025

Description

Update ansys-sphinx-theme to 1.4.4 to mitigate CICD failure because of ansys/ansys-sphinx-theme#685

Under suggestion of sourcery-ai[bot] I have also updated the requirements in the codespaces.

Issue linked

Related to ansys/ansys-sphinx-theme#685

Checklist

Summary by Sourcery

Update ansys-sphinx-theme to version 1.4.4 across project requirements files to address CICD issues

Bug Fixes:

  • Mitigated CICD failure related to sphinx theme version

Chores:

  • Updated ansys-sphinx-theme version in multiple requirements files and project configuration

@germa89 germa89 requested a review from a team as a code owner May 8, 2025 11:35
@germa89 germa89 requested review from clatapie and pyansys-ci-bot May 8, 2025 11:35
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

Copy link
Contributor

sourcery-ai bot commented May 8, 2025

Reviewer's Guide

This pull request updates the ansys-sphinx-theme dependency to version 1.4.4 in requirements.txt files located in .devcontainer subdirectories and in pyproject.toml. The GitHub Actions workflow doc-build.yml was also adjusted by removing an explicit uninstallation of ansys-sphinx-theme, ensuring the updated version is utilized during the documentation build process.

File-Level Changes

Change Details Files
Updated ansys-sphinx-theme version.
  • Modified ansys-sphinx-theme from version 1.4.2 to 1.4.4.
.devcontainer/codespaces-docs/requirements.txt
.devcontainer/devcontainer-local/requirements.txt
pyproject.toml
Adjusted documentation build workflow.
  • Removed the pip uninstall ansys-sphinx-theme command to allow the version specified in project dependencies to be used.
.github/workflows/doc-build.yml

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!

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

@germa89 germa89 self-assigned this May 8, 2025
@germa89
Copy link
Collaborator Author

germa89 commented May 8, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 enabled auto-merge (squash) May 8, 2025 11:36
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc dependencies maintenance General maintenance of the repo (libraries, cicd, etc) bug Issue, problem or error in PyMAPDL labels May 8, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @germa89 - I've reviewed your changes - here's some feedback:

  • Consider synchronizing the versions of ansys-mapdl-reader and ansys-tools-visualization-interface across pyproject.toml (doc extras) and the .devcontainer requirements files for better environment consistency.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

…alization-interface to 0.9.1 in requirements files
@github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label May 8, 2025
@RobPasMue
Copy link
Member

Not strictly needed anymore but a good practice definitely 😄 -- the snowballstemmer team just yanked their version

Copy link

codecov bot commented May 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.28%. Comparing base (1b1b6b4) to head (00cd7bc).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3904      +/-   ##
==========================================
- Coverage   88.29%   88.28%   -0.02%     
==========================================
  Files         187      187              
  Lines       14830    14830              
==========================================
- Hits        13094    13092       -2     
- Misses       1736     1738       +2     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 merged commit a269e75 into main May 8, 2025
83 of 87 checks passed
@germa89 germa89 deleted the build/update-ansys-sphinx-theme-to-1.4.4 branch May 8, 2025 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Issue, problem or error in PyMAPDL CI/CD Related with CICD, Github Actions, etc dependencies documentation Documentation related (improving, adding, etc) maintenance General maintenance of the repo (libraries, cicd, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants