Skip to content

Conversation

zmx27
Copy link
Contributor

@zmx27 zmx27 commented Aug 6, 2025

What problem does this PR address?

In requirements/docs.txt, m2r is installed as a dependency when the docs are being built. However, docs/source/conf.py lists m2r2 instead of m2r as one of the extensions being used by Sphinx to build the docs. This causes an error when building the docs. This PR fixes this error by updating the conf.py extensions so it is in sync with the dependencies listed in requirements/docs.txt.

What should the reviewer(s) do?

Please review and merge.

@zmx27 zmx27 marked this pull request as ready for review August 6, 2025 19:44
Copy link

codecov bot commented Aug 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.60%. Comparing base (de32312) to head (75fd23a).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #130   +/-   ##
=======================================
  Coverage   66.60%   66.60%           
=======================================
  Files          25       25           
  Lines        3171     3171           
=======================================
  Hits         2112     2112           
  Misses       1059     1059           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zmx27
Copy link
Contributor Author

zmx27 commented Aug 6, 2025

@sbillinge ready for review

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

It is better if we can go with m2r2 rather than m2r which is no longer maintained. Do things build correctly if we do that?

@zmx27
Copy link
Contributor Author

zmx27 commented Aug 6, 2025

@sbillinge yes, I've tested it locally and the docs will still build correctly if we use m2r2. I've updated conf.py and the requirements folder to now use m2r2 instead of m2r. This is ready for review.

@sbillinge sbillinge merged commit e368e57 into diffpy:main Aug 6, 2025
5 checks passed
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