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

link docs to types from Julia, PencilArrays and PencilFFTs #184

Closed
musoke opened this issue Apr 12, 2024 · 0 comments
Closed

link docs to types from Julia, PencilArrays and PencilFFTs #184

musoke opened this issue Apr 12, 2024 · 0 comments

Comments

@musoke
Copy link
Owner

musoke commented Apr 12, 2024

New versions of Documenter (> v1.3.0 ?) allow linking to docs of external projects.

https://documenter.juliadocs.org/stable/man/guide/#External-Cross-References
http://juliadocs.org/DocumenterInterLinks.jl/stable/

Do this.

musoke added a commit that referenced this issue Apr 12, 2024
Use `DocumenterInterLinks.jl` to link to objects in `Julia.Core`,
`PencilArrays` and `PencilFFTs`.

The docs for the stable branches of `PencilArrays` and `PencilFFTs`
don't have `DocumenterInterLinks` inventories yet, so link to the docs
for the dev branches.

Julia does not have an inventory file at all, so use the one from
https://github.com/JuliaDocs/DocumenterInterLinks.jl/wiki/Inventory-File-Repository

Fixes: #184
musoke added a commit that referenced this issue Apr 12, 2024
Use `DocumenterInterLinks.jl` to link to objects in `Julia.Core`,
`PencilArrays` and `PencilFFTs`.

The docs for the stable branches of `PencilArrays` and `PencilFFTs`
don't have `DocumenterInterLinks` inventories yet, so link to the docs
for the dev branches.

Julia does not have an inventory file at all, so use the one from
https://github.com/JuliaDocs/DocumenterInterLinks.jl/wiki/Inventory-File-Repository

Fixes: #184
@musoke musoke closed this as completed in 2221866 Apr 12, 2024
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

1 participant