Skip to content

Fix fully-qualified QbFields path in Sphinx nitpicky config#62

Merged
harryswift01 merged 1 commit intomainfrom
61-sphinx-build-fails
Jan 21, 2026
Merged

Fix fully-qualified QbFields path in Sphinx nitpicky config#62
harryswift01 merged 1 commit intomainfrom
61-sphinx-build-fails

Conversation

@harryswift01
Copy link
Copy Markdown
Member

Summary

This PR updates the Sphinx nitpicky ignore configuration to use the fully‑qualified import path for a deprecated aiida symbol, fixing a clean-build failure under -nW.

Changes

Fix QbFields reference path in Sphinx config

  • Update nitpick_ignore to use aiida.orm.fields.QbFields instead of the unqualified name.
  • Prevents first‑run Sphinx failures caused by unresolved autodoc cross‑references.
  • Makes documentation builds deterministic under strict (-nW) settings.

Impact

  • Stabilises clean documentation builds (including CI).
  • No functional impact on runtime code.
  • Improves compatibility with newer aiida versions and strict Sphinx configurations.

@harryswift01 harryswift01 self-assigned this Jan 21, 2026
@coveralls
Copy link
Copy Markdown
Collaborator

Pull Request Test Coverage Report for Build 21207905270

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 81.949%

Totals Coverage Status
Change from base Build 21207484124: 0.0%
Covered Lines: 1026
Relevant Lines: 1252

💛 - Coveralls

Copy link
Copy Markdown
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

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

Good catch, safe to ignore this because it is inbuilt DFT fields

@harryswift01 harryswift01 merged commit 59fad85 into main Jan 21, 2026
10 checks passed
@harryswift01 harryswift01 deleted the 61-sphinx-build-fails branch January 21, 2026 13:39
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.

Sphinx build fails on first run due to unresolved QbFields reference

3 participants