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

Fix source links in API documentation #2605

Merged
merged 7 commits into from
Jun 15, 2023
Merged

Fix source links in API documentation #2605

merged 7 commits into from
Jun 15, 2023

Conversation

ysthakur
Copy link
Contributor

@ysthakur ysthakur commented Jun 13, 2023

The API documentation has links to local files (e.g. mill.define.Args points to file:///home/runner/work/mill/mill/main/define/src/mill/define/Args.scala). This PR is for fixing that.

There's already code to replace every occurrence of file://path/to/project/root with the right URL, but it's for .scala files so I didn't touch it. I figured -sourcepath was a safer way to do the same thing.

@ysthakur ysthakur marked this pull request as draft June 13, 2023 20:21
@ysthakur ysthakur marked this pull request as ready for review June 13, 2023 20:31
@ysthakur
Copy link
Contributor Author

ysthakur commented Jun 14, 2023

Just realized this doesn't handle unidocLocal properly, easy fix though, just can't merge yet

@ysthakur
Copy link
Contributor Author

Okay, tested unidocLocal (and unidocSite) and it seems to work now.

Copy link
Member

@lefou lefou left a comment

Choose a reason for hiding this comment

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

Looks good, I guess. Thank you!

@lefou lefou merged commit 167b6e6 into com-lihaoyi:main Jun 15, 2023
37 checks passed
@lefou lefou added this to the 0.11.1 milestone Jun 15, 2023
@ysthakur ysthakur deleted the unidoc-site-fix branch June 15, 2023 22:23
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.

None yet

2 participants