Skip to content

docs: use experimental quartodoc autolinks #191

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 6 commits into
base: main
Choose a base branch
from

Conversation

machow
Copy link
Collaborator

@machow machow commented May 21, 2025

This PR adds updates the quartodoc interlinks filter, and enables the new autolinks feature. This should turn links like pb.Validate() into links to the appropriate API Reference page.

@codecov-commenter
Copy link

codecov-commenter commented May 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.06%. Comparing base (366a04e) to head (648180d).
Report is 29 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #191   +/-   ##
=======================================
  Coverage   99.05%   99.06%           
=======================================
  Files          18       18           
  Lines        4467     4480   +13     
=======================================
+ Hits         4425     4438   +13     
  Misses         42       42           

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

@github-actions github-actions bot temporarily deployed to pr-191 May 21, 2025 20:00 Destroyed
@github-actions github-actions bot temporarily deployed to pr-191 May 22, 2025 18:11 Destroyed
@github-actions github-actions bot temporarily deployed to pr-191 May 22, 2025 18:34 Destroyed
@machow
Copy link
Collaborator Author

machow commented May 22, 2025

@rich-iannone if you have a bit of time, do you mind trying out converting some of the manual links to use the new autolink syntax?

Here are two I did in the index.qmd file in the guide:

  • `Validate`: now converted automatically to a link
  • `Validate.interrogate()`: before, this was just .interrogate(). I'll look into re-enabling link shortening syntax, so something like `~~Validate.interrogate()` would shorten the text to .interrogate()

Feel free to commit here, and if there are any useful behaviors you'd want, def note them!

@rich-iannone
Copy link
Member

Thanks! I'll choose one of the user guide pages and push directly to this PR.

@rich-iannone
Copy link
Member

From looking at the preview for the two extra guide pages, everything seems to be linking well!

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.

3 participants