Skip to content

Fix doc build by disallowing numpydoc v1.9.0 #571

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

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

hakonanes
Copy link
Member

Description of the change

This PR fixes the documentation build by disallowing numpydoc v1.9.0, thus fixing #570.

There are some other minor changes:

  • fix some incorrectly formatted docstrings
  • simplify addition of custom pytest markers (now that we have the "slow" marker)
  • also renamed the flag to run tests marked with "slow" from "runslow" to "slow", i.e. pytest --slow is the way to do it now
  • update type hints in some quaternion module files

Progress of the PR

Minimal example of the bug fix or new feature

Not relevant as no API changes were made.

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in
    .zenodo.json.

@hakonanes hakonanes added this to the v0.14.0 milestone Jul 10, 2025
@hakonanes hakonanes added bug Something isn't working dev Package maintenance documentation Relates to the documentation labels Jul 10, 2025
@hakonanes hakonanes requested a review from argerlt July 10, 2025 09:24
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
…em#570)

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes force-pushed the 570-fix-doc-build-numpydoc branch from fd7cc0c to 7632cef Compare July 10, 2025 09:27
@hakonanes hakonanes linked an issue Jul 10, 2025 that may be closed by this pull request
@hakonanes
Copy link
Member Author

Errors are related to me being a bit too fast replacing paths in test fixtures... Will fix tomorrow.

…m#570)

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
…yxem#570)

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dev Package maintenance documentation Relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation build fails due to bug in numpydoc v1.9.0
1 participant