Skip to content

Conversation

@rg936672
Copy link
Contributor

PR Type

  • Build related changes

Description

In Sphinx 8.2.x, sphinxcontrib-bibtex no longer works with absolute paths to the bibliography file. I think this is a bug, since it worked in Sphinx 8.1.x, so I've reported it at mcmtroffaes/sphinxcontrib-bibtex#361. However, as an immediate fix, I've ensured that the bibliography file path is relative to the documentation source folder. Closes #989.

How Has This Been Tested?

Docs build passes; bibliography is present.

Does this PR introduce a breaking change?

No.

Checklist before requesting a review

  • I have made sure that my PR is not a duplicate.
  • My code follows the style guidelines of this project.
  • I have ensured my code is easy to understand, including docstrings and comments where necessary.
  • I have performed a self-review of my code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.
  • I have updated CHANGELOG.md, if appropriate.

Updated anyio v4.8.0 -> v4.9.0
Updated async-lru v2.0.4 -> v2.0.5
Updated coverage v7.6.12 -> v7.7.0
Updated iniconfig v2.0.0 -> v2.1.0
Updated jaxtyping v0.2.36, v0.2.38 -> v0.2.36, v0.3.0
Updated mistune v3.1.2 -> v3.1.3
Updated platformdirs v4.3.6 -> v4.3.7
Updated pre-commit v4.1.0 -> v4.2.0
Updated pyright v1.1.396 -> v1.1.397
Updated pywin32 v309 -> v310
Added roman-numerals-py v3.1.0
Updated setuptools v76.0.0 -> v77.0.1
Updated sphinx v7.4.7, v8.1.3 -> v7.4.7, v8.1.3, v8.2.3
Updated sphinx-autodoc-typehints v2.3.0, v3.0.1 -> v2.3.0, v3.0.1, v3.1.0
Updated trove-classifiers v2025.3.13.13 -> v2025.3.19.19
This seems to be a bug in sphinxcontrib-bibtex - I've reported it at
mcmtroffaes/sphinxcontrib-bibtex#361.
@rg936672 rg936672 changed the title Fix/sphinx 8.2 Fix compatibility with sphinx 8.2.x Mar 20, 2025
@github-actions
Copy link
Contributor

Performance review

Commit 65c6e52 - Merge 03116a1 into 6ed8e9d

No significant changes to performance.

@rg936672 rg936672 marked this pull request as ready for review March 20, 2025 10:57
Copy link
Contributor

@bk958178 bk958178 left a comment

Choose a reason for hiding this comment

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

Thanks @rg936672 . LGTM. Approving and merging

@bk958178 bk958178 merged commit c9dcab7 into main Mar 21, 2025
23 checks passed
@tp832944 tp832944 deleted the fix/sphinx-8.2 branch March 24, 2025 16:05
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.

Incompatible with Sphinx 8.2.x

3 participants