skrub-data/skrub

One of the hyperlinks in the examples section of the Documentation not working

Closed this issue · 1 comments

Describe the bug

The third example on the website https://skrub-data.org/stable/auto_examples/index.html "Handling datetime features with the DatetimeEncoder" cannot be clicked. It lacks the hyperlink and therefore you can't open it.

On the picture below you can see the html sourcecode. You can see that the example (B - letter on the picture) has html tag with "href" property (A - letter on the picture). So the second example link works properly and you can click it. However, the third example has no tag, instead it has tag with text description. It lacks any kind of link to the example.

obraz

Steps/Code to Reproduce

You can use your webbrowser's Developer Tools to see the html code underneath the invalid button.

Expected Results

Expected result would be that the third example has <a class="reference internal" href="03_datetime_encoder.html#sphx-glr-auto-examples-03-datetime-encoder-py"><span class="std std-ref">Handling datetime features with the DatetimeEncoder</span></a>

so the user would be able to click it and see the example.

I also strongly suggest having a pure notebook directory with examples as .ipynb so the users don't need to rely on sphinx autogenerated sites.

Actual Results

Actual code doesn't have the tag, only span:

sphx_glr_auto_examples_03_datetime_encoder.py

Versions

It doesn't rely on any skrub version so it's not needed.

Thank you for spotting this broken URL; I made a PR to fix it. The example should be accessible on the website soon.

Regarding generating these examples, we prefer sticking to our Sphinx methodology: having Python files easily read on GitHub and quickly parsed by Sphinx. When making PRs, notebooks' code differences are challenging to read and often lead to massive line changes.