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

Documentation cross references between packages #55

Open
c42f opened this issue Jun 23, 2020 · 0 comments
Open

Documentation cross references between packages #55

c42f opened this issue Jun 23, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@c42f
Copy link

c42f commented Jun 23, 2020

Given that JuliaHub can now build and serve most package documentation, it would be really neat if packages could link to symbols which they import from other packages with @ref and have that generate a link to the other package's documentation.

This would greatly improve the user experience of the Julia ecosystem documentation as a whole.

This could be done with some customization of the way that @ref is looked up by Documenter - see some related Documenter issues:
JuliaDocs/Documenter.jl#1343
JuliaDocs/Documenter.jl#319

Documenter configuration currently isn't declarative which makes this more difficult than it might ideally be, but perhaps that can also be fixed eventually (see JuliaDocs/Documenter.jl#1087 (comment)).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants