Skip to content

Conversation

@hugovk
Copy link

@hugovk hugovk commented Dec 13, 2025

This should fix the EPUB failures on python#142676.


📚 Documentation preview 📚: https://cpython-previews--116.org.readthedocs.build/

Comment on lines +442 to +443
'_static/tachyon-example-flamegraph.html',
'_static/tachyon-example-heatmap.html',
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to include the examples for the EPUB build, so exclude them.

GIL metrics, and hotspot functions.
:download:`Try the interactive example </_static/tachyon-example-flamegraph.html>`.

.. only:: html
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tells Sphinx to only include this link for the HTML build. So not for EPUB or any other builders like plaintext. We don't do PDF, but others might build that.

Unfortunately, it seems Sphinx only supports this at the top-level, which means the following link isn't indented like the figure text above. And the text is now a separate paragraph rather than part of the figure text.


.. only:: html

`Try the interactive example <../_static/tachyon-example-flamegraph.html>`__.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we make this a regular link rather than use the download role, we (1) can see the served HTML file on the docs server and (2) the link shows up in normal text and not monospaced font.

Before:

image

After:

image

@pablogsal pablogsal merged commit 0fc4a92 into pablogsal:tachyon-images Dec 14, 2025
4 checks passed
@hugovk hugovk deleted the 3.15-tachyon-images branch December 14, 2025 07:38
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.

2 participants