Conversation
Miauwkeru
commented
Aug 28, 2025
- Enable fail on warning for docs generation
- Fix documentation issues
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3 +/- ##
==========================================
+ Coverage 82.38% 83.37% +0.99%
==========================================
Files 7 7
Lines 386 379 -7
==========================================
- Hits 318 316 -2
+ Misses 68 63 -5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tests/_docs/conf.py
Outdated
| # https://github.com/readthedocs/sphinx-autoapi/issues/285 | ||
| "autoapi.python_import_resolution", | ||
| # https://github.com/sphinx-doc/sphinx/issues/4961 | ||
| "ref.python", |
There was a problem hiding this comment.
keeping it consistent with dissect-docs, and dissect.cstruct. I'd personally prefer that each project has consistent configuration
There was a problem hiding this comment.
None of the other projects have it so the question then becomes, which one defines consistency 😄 also didn't really answer the question, what's it for?
There was a problem hiding this comment.
ref is indeed not needed on this project, the autoapi.python_import_resolution is
Schamper
left a comment
There was a problem hiding this comment.
This will break dissect.target: https://github.com/fox-it/dissect.target/blob/main/dissect/target/filesystems/qnxfs.py
Can you make a linked PR?