Skip to content
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

Use <url> for links in python docs #7325

Merged
merged 6 commits into from
Sep 2, 2024
Merged

Use <url> for links in python docs #7325

merged 6 commits into from
Sep 2, 2024

Conversation

emilk
Copy link
Member

@emilk emilk commented Sep 2, 2024

Fixes warning in https://github.com/rerun-io/rerun/actions/runs/10662695291/job/29550372867?pr=7319

WARNING - mkdocs_autorefs: common/blueprint_apis.md: Could not find cross-reference target ’#6673'

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

@emilk emilk added 📖 documentation Improvements or additions to documentation 🚢 CI exclude from changelog PRs with this won't show up in CHANGELOG.md labels Sep 2, 2024
Copy link
Member

@abey79 abey79 left a comment

Choose a reason for hiding this comment

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

Shouldn't the link in tensor_data.fbs be fixed as well?

@emilk
Copy link
Member Author

emilk commented Sep 2, 2024

Shouldn't the link in tensor_data.fbs be fixed as well?

All links in all python docs should be on the <…> form, but only those using the wrong […][] syntax will actually produce warnings.

Copy link

github-actions bot commented Sep 2, 2024

Deployed docs

Commit Link
11a816f https://landing-mtwxuzlca-rerun.vercel.app/docs

Copy link
Member

@abey79 abey79 left a comment

Choose a reason for hiding this comment

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

Nice!

@emilk emilk merged commit 5df2aed into main Sep 2, 2024
40 checks passed
@emilk emilk deleted the emilk/fix-py-link branch September 2, 2024 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md 🚢 CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants