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

Manually add objects.inv for 1.10.2 #28

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

goerz
Copy link
Contributor

@goerz goerz commented Mar 26, 2024

File was manually generated the same way as in JuliaLang/julia#53597

This is a one-time fix, since subsequent releases of Julia should write the inventory file automatically:

This PR will make the inventory file available "immediately" to the current online docs. I'm still planning to make an announcement of DocumenterInterLinks soonish, and it would be extra nice if I could say

Put

links = InterLinks(
    "Julia" => "https://docs.julialang.org/en/v1/",
)

in your make.jl file

instead of

Download and unzip the Julia.toml file from https://github.com/JuliaDocs/DocumenterInterLinks.jl/wiki/Inventory-File-Repository, put it in your docs/src/inventories folder, and then add

links = InterLinks(
    "Julia" => (
        "https://docs.julialang.org/en/v1/",
        "https://docs.julialang.org/en/v1/objects.inv",
        joinpath(@__DIR__, "src", "inventories", "Julia.toml"),
    ),
)

in your make.jl file.

So, I'm hoping you can make an exception to

Pull Requests will not be accepted to this repository.
Contributions for the Julia documentation should be made to
Julia's GitHub repository (https://github.com/JuliaLang/julia).

@goerz
Copy link
Contributor Author

goerz commented Mar 26, 2024

@mortenpi

@goerz
Copy link
Contributor Author

goerz commented Mar 26, 2024

Ugh, hold on, I screwed that up (wrong format: toml, not objects.inv)

File was manually generated, cf.
https://github.com/JuliaDocs/DocumenterInterLinks.jl/wiki/Inventory-File-Repository

Subsequent releases of Julia should write the inventory file
automatically, but it would be nice to have it in the current version as
well.
@goerz
Copy link
Contributor Author

goerz commented Mar 26, 2024

Ok, fixed. Sorry about that.

@mortenpi
Copy link
Collaborator

Ah, we should have merged this ages ago sorry!

@mortenpi mortenpi merged commit 237abbf into JuliaLang:gh-pages Apr 24, 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

Successfully merging this pull request may close these issues.

2 participants