Skip to content

feat: manually implement sphinx inv header parsing #31

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

savente93
Copy link
Owner

Some work let to do, but given that so many other documentation sites are built with sphinx it is still useful to be able to link them. This will hopefully also help me design a good linking system for snakedown itself. For now all we do is parsing, but I also want to add the ability to link to the objects.inv, download and then use that. Some good error handling will also be necessary.

Creating this draft PR to more easily track the progress, even though the history will need some cleanup.

@savente93 savente93 marked this pull request as draft June 25, 2025 09:45
Copy link

codecov bot commented Jun 25, 2025

Codecov Report

Attention: Patch coverage is 89.84375% with 39 lines in your changes missing coverage. Please review.

Project coverage is 96.7%. Comparing base (0cf62c9) to head (3f2eb8e).

Files with missing lines Patch % Lines
src/indexing/fetch.rs 58.4% 22 Missing ⚠️
src/parsing/sphinx/types.rs 88.8% 13 Missing ⚠️
src/parsing/sphinx/inv_file.rs 98.2% 3 Missing ⚠️
src/indexing/cache.rs 97.7% 1 Missing ⚠️
Additional details and impacted files
Files with missing lines Coverage Δ
src/lib.rs 89.5% <ø> (ø)
src/indexing/cache.rs 97.7% <97.7%> (ø)
src/parsing/sphinx/inv_file.rs 98.2% <98.2%> (ø)
src/parsing/sphinx/types.rs 88.8% <88.8%> (ø)
src/indexing/fetch.rs 58.4% <58.4%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@savente93 savente93 force-pushed the feat/sphinx-inv-parsing branch 2 times, most recently from 1d493a1 to 0deeaf2 Compare June 26, 2025 17:43
@savente93 savente93 force-pushed the feat/sphinx-inv-parsing branch from 0deeaf2 to 3f2eb8e Compare June 26, 2025 18:06
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.

1 participant