Skip to content

feat!: enable show source links#363

Draft
machow wants to merge 3 commits intomainfrom
feat-source-link
Draft

feat!: enable show source links#363
machow wants to merge 3 commits intomainfrom
feat-source-link

Conversation

@machow
Copy link
Copy Markdown
Owner

@machow machow commented Aug 27, 2024

This PR adds a show source link to rendered item docs. Addresses #354

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Aug 27, 2024

Codecov Report

❌ Patch coverage is 77.63158% with 17 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.18%. Comparing base (4739a4e) to head (8a18dbd).
⚠️ Report is 58 commits behind head on main.

Files with missing lines Patch % Lines
quartodoc/repo_info.py 78.04% 9 Missing ⚠️
quartodoc/renderers/md_renderer.py 60.00% 6 Missing ⚠️
quartodoc/autosummary.py 60.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #363      +/-   ##
==========================================
- Coverage   88.46%   88.18%   -0.29%     
==========================================
  Files          37       39       +2     
  Lines        2931     3005      +74     
==========================================
+ Hits         2593     2650      +57     
- Misses        338      355      +17     

☔ 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.

@cliffckerr
Copy link
Copy Markdown

Would love to have this feature! Any estimate of when it will be released?

@michaelaye
Copy link
Copy Markdown

I just had Claude Code do a deep research on my quartodoc sourcelink options, it found this PR but suggested to create our own and give it back here. So it made this custom renderer, maybe this would help for an official implementation here? Seems to work fine, see an example here. Hope it helps and thanks for quartodoc!

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.

4 participants