Skip to content

Fix sphinx documentation issues#3

Merged
Miauwkeru merged 3 commits intomainfrom
fix-sphinx-documentation-issues
Sep 1, 2025
Merged

Fix sphinx documentation issues#3
Miauwkeru merged 3 commits intomainfrom
fix-sphinx-documentation-issues

Conversation

@Miauwkeru
Copy link
Copy Markdown
Contributor

  • Enable fail on warning for docs generation
  • Fix documentation issues

@codecov
Copy link
Copy Markdown

codecov bot commented Aug 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.37%. Comparing base (bffdcac) to head (7964cc6).
⚠️ Report is 1 commits behind head on main.

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     
Flag Coverage Δ
unittests 83.37% <100.00%> (+0.99%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

# https://github.com/readthedocs/sphinx-autoapi/issues/285
"autoapi.python_import_resolution",
# https://github.com/sphinx-doc/sphinx/issues/4961
"ref.python",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What's this for?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

keeping it consistent with dissect-docs, and dissect.cstruct. I'd personally prefer that each project has consistent configuration

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ref is indeed not needed on this project, the autoapi.python_import_resolution is

Copy link
Copy Markdown
Member

@Schamper Schamper left a comment

Choose a reason for hiding this comment

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

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?

@Miauwkeru Miauwkeru merged commit adee9ab into main Sep 1, 2025
25 checks passed
@Miauwkeru Miauwkeru deleted the fix-sphinx-documentation-issues branch September 1, 2025 10:17
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