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.

Sign up for GitHub

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

Jump to bottom

Formatting errors in the tutorial #213

Closed
CarloLucibello opened this issue Oct 16, 2022 · 14 comments · Fixed by #214
Closed

Formatting errors in the tutorial #213

CarloLucibello opened this issue Oct 16, 2022 · 14 comments · Fixed by #214
Assignees
@Dsantra92

Comments

@CarloLucibello
Copy link
Member

The are some HTML artefacts in the tutorials, see https://carlolucibello.github.io/GraphNeuralNetworks.jl/dev/tutorials/introductory_tutorials/graph_classification_pluto/#Graph-Classification-with-Graph-Neural-Networks
@Dsantra92
Copy link
Collaborator

No such issues on my local. I am looking into this.

@Dsantra92
Copy link
Collaborator

Looks like an issue with the frontmatter and my local DemoCards.jl is ahead of the upstream. Working on some changes and will get them done by EOD.

@Dsantra92
Copy link
Collaborator

Should be fixed in the new DemoCards.jl release.

@Dsantra92 Dsantra92 mentioned this issue Oct 17, 2022
Merged
@CarloLucibello
Copy link
Member Author

looks like #214 was not enough to fix it

@Dsantra92
Copy link
Collaborator

Dsantra92 commented Oct 17, 2022 •
edited
Loading

The issue is the markdown file is not converted to HTML properly. Still not sure what's the reason behind it. The part of the markdown file that causes the issue is

 ## Mini-batching of graphs

My locally rendered html section looks like

<h2 id="Mini-batching-of-graphs"><a class="docs-heading-anchor" href="#Mini-batching-of-graphs">Mini-batching of graphs</a><a id="Mini-batching-of-graphs-1"></a><a class="docs-heading-anchor-permalink" href="#Mini-batching-of-graphs" title="Permalink"></a></h2><div class="markdown">

the prod build, shows something like,

<!DOCTYPE ><HTML><head></head><body> 
```## Implementing Graph Neural Networks<p>...<\p>

Now, documenter.jl could easily handle prev notebooks (literally the same) as seen in the stable branch docs. I am looking if it's democard thing.

@CarloLucibello
Copy link
Member Author

@Dsantra92 did you menage to understand the cause of the error? We cannot overcome the issue I will have to revert to the old tutorials

@Dsantra92
Copy link
Collaborator

Thanks for the reminder, I will try to fix it within 2 days. If cannot find the issue by then, we can revert.

@Dsantra92
Copy link
Collaborator

The issue is fixed ig.

@CarloLucibello
Copy link
Member Author

What do you mean? Fixed where?

@CarloLucibello
Copy link
Member Author

Right, now I see no problems https://carlolucibello.github.io/GraphNeuralNetworks.jl/dev/tutorials/introductory_tutorials/node_classification_pluto/#Node-Classification-with-Graph-Neural-Networks
What happened?

@Dsantra92
Copy link
Collaborator

Dsantra92 commented Nov 2, 2022 •
edited
Loading

Got fixed here in rikhuijzer/PlutoStaticHTML.jl#153. The new docs are using PlutoStaticHTML 0.6.6 while older docs with rendering problems used 0.6.5.

@Dsantra92
Copy link
Collaborator

Should we make the PlutoStaticHTML version more explicit in the docs and make it more relaxed once it reaches v1?

@CarloLucibello
Copy link
Member Author

Doing it in #218 , thanks

@CarloLucibello
Copy link
Member Author

Should we make the PlutoStaticHTML version more explicit in the docs and make it more relaxed once it reaches v1?

Actually that should be done in DemoCards.jl

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Dsantra92 Dsantra92

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Switch to default pluto frontmatter Dsantra92/GraphNeuralNetworks.jl
2 participants
@CarloLucibello @Dsantra92