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

In Literate-generated tutorials the input code and the output have the same style #590

Open
CarloLucibello opened this issue Feb 7, 2025 · 1 comment
Assignees
Labels
docs Improvements or additions to documentation flux

Comments

@CarloLucibello
Copy link
Member

In tutorials like
https://juliagraphs.org/GraphNeuralNetworks.jl/docs/GraphNeuralNetworks.jl/dev/tutorials/gnn_intro/
the input code and the output both have a grey background and are not distinguishable.

Normally the output would have a white background instead, see
https://fredrikekre.github.io/Literate.jl/v2/generated/example/

I have no clue why this happens, we are not using any custom style in Documeter.

cc @aurorarossi

@CarloLucibello CarloLucibello added docs Improvements or additions to documentation flux labels Feb 7, 2025
@aurorarossi aurorarossi self-assigned this Feb 7, 2025
@aurorarossi
Copy link
Member

I found that the appearance of the generated Markdown file depends on when the evaluation occurs. As we were already generating the Markdown output locally with cell evaluation enabled, Documenter renders it using a single color. However, if we generate the Markdown so that Documenter evaluates the cells, different colors are used.

I agree that having two colors is better, but making Documenter evaluate the tutorials every time is inefficient—especially for temporal ones(perhaps a better solution would be to create lighter temporal tutorials)

There is already an open issue fredrikekre/Literate.jl#178 on Literate and also Documenter, but it doesn’t seem to be receiving attention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation flux
Projects
None yet
Development

No branches or pull requests

2 participants