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

@ref links to Julia docs #425

Closed
denizyuret opened this issue Feb 9, 2017 · 3 comments
Closed

@ref links to Julia docs #425

denizyuret opened this issue Feb 9, 2017 · 3 comments

Comments

@denizyuret
Copy link

I am almost done porting all of Knet docs to Documenter, so far a great experience, thanks for an awesome utility!

Knet overloads a lot of Julia Base functions, which I want to refer to in the docs. Is there an easy way to automatically generate links for them to point to Julia docs from Knet docs?

@mortenpi
Copy link
Member

This is not supported at the moment and would be tricky to support since each package and the julia manual are built and hosted separately. That is, there's no way to resolve the @ref link to an external URL when building docs for a package.

@denizyuret
Copy link
Author

Good point, thanks!

@goerz
Copy link
Member

goerz commented Jan 7, 2024

This is now possible with DocumenterInterLinks.jl. Although, until #2366 is accepted and Julia then moves to a future Documenter release that automatically writes inventories, you would have to manually use this inventory file for Julia 1.10. It would allow you to put something like

* [`sort(inventory)`](@extref Julia Base.sort) – convert an unsorted inventory
  into a sorted one.

into your docstrings.

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

No branches or pull requests

3 participants