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

Documenter 1.0 upgrade. #858

Merged
merged 3 commits into from
Oct 7, 2023
Merged

Documenter 1.0 upgrade. #858

merged 3 commits into from
Oct 7, 2023

Conversation

ArnoStrouwen
Copy link
Member

Also adds formatter workflow in anticipation of formatter being fixed.
Formatting has thus not yet been applied.

@ChrisRackauckas
Copy link
Member

@ArnoStrouwen can you rebase this? And how do we find that lux link?

@ChrisRackauckas
Copy link
Member

we can just point to the lux docs

@ArnoStrouwen
Copy link
Member Author

The SciML multi documenter is not able to find the Lux docs:
https://docs.sciml.ai/Lux/
https://github.com/SciML/SciMLDocs/blob/main/docs/make_aggregate.jl#L134C32-L134C63
Lux has some extra things going on with Documenter, namely Vitepress:
https://github.com/LuxDL/Lux.jl/blob/main/docs/make.jl
Is this the reason that it fails?
@mortenpi could you please give your opinion?

@ChrisRackauckas
Copy link
Member

Just link to the lux website and remove from here.

@ArnoStrouwen
Copy link
Member Author

Is this a known stochastic failure? Was not there the last time it ran, and only a link changed.
https://buildkite.com/julialang/diffeqflux-dot-jl/builds/1353#018b0509-9480-40bb-9631-66f15bdd5220/896-1547

@ArnoStrouwen
Copy link
Member Author

Should be good to go except for the weird failure.

@ChrisRackauckas
Copy link
Member

Complete!

@ChrisRackauckas ChrisRackauckas merged commit 93c928f into SciML:master Oct 7, 2023
2 of 11 checks passed
@ArnoStrouwen ArnoStrouwen deleted the docs branch October 7, 2023 12:52
@mortenpi
Copy link

mortenpi commented Oct 7, 2023

Lux has some extra things going on with Documenter, namely Vitepress:

Yeah, it looks like Lux is nowadays committing (Vitepress) Markdown files to gh-pages and then using that to deploy the full site in the gh-pages workflow. This means that we don't really have access to the generated HTML, and so can't really include that in a MultiDocumenter build.

Note that the SciML aggregate builds are not broken per se, it's just they're pushing Markdown files to S3: https://docs.sciml.ai/Lux/stable/manual/weight_initializers.md

So I feel that Lux should probably be removed from the aggregate site build?

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.

3 participants