GraphNeuralNetworks.jl icon indicating copy to clipboard operation
GraphNeuralNetworks.jl copied to clipboard

Formatting errors in the tutorial

Open CarloLucibello opened this issue 3 years ago • 5 comments

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

CarloLucibello avatar Oct 16 '22 10:10 CarloLucibello

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

Dsantra92 avatar Oct 16 '22 17:10 Dsantra92

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 avatar Oct 16 '22 17:10 Dsantra92

Should be fixed in the new DemoCards.jl release.

Dsantra92 avatar Oct 17 '22 01:10 Dsantra92

looks like #214 was not enough to fix it

CarloLucibello avatar Oct 17 '22 15:10 CarloLucibello

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.

Dsantra92 avatar Oct 17 '22 15:10 Dsantra92

@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

CarloLucibello avatar Oct 29 '22 09:10 CarloLucibello

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

Dsantra92 avatar Oct 29 '22 09:10 Dsantra92

The issue is fixed ig.

Dsantra92 avatar Nov 02 '22 15:11 Dsantra92

What do you mean? Fixed where?

CarloLucibello avatar Nov 02 '22 16:11 CarloLucibello

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?

CarloLucibello avatar Nov 02 '22 16:11 CarloLucibello

Got fixed here in https://github.com/rikhuijzer/PlutoStaticHTML.jl/pull/153. The new docs are using PlutoStaticHTML 0.6.6 while older docs with rendering problems used 0.6.5.

Dsantra92 avatar Nov 02 '22 17:11 Dsantra92

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

Dsantra92 avatar Nov 02 '22 17:11 Dsantra92

Doing it in #218 , thanks

CarloLucibello avatar Nov 03 '22 09:11 CarloLucibello

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

CarloLucibello avatar Nov 03 '22 09:11 CarloLucibello