Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Docs: mention that Sphinx>=3.5 may not work with dynamic content #124

Merged
merged 1 commit into from
May 6, 2021
Merged

Docs: mention that Sphinx>=3.5 may not work with dynamic content #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,15 @@ These actions are usually calling a Javascript function.
``hoverxref`` is prepared to support this type of content and currently supports rendering
`sphinx-tabs`_ and mathjax_.

.. warning::

Note that Sphinx>3.5 adds `a feature to only include JS/CSS in pages where they are used`_ instead of in all the pages.
This `may affect the rendering of tooltips`_ that includes content requiring extra rendering steps.
**Make sure you are using Sphinx 3.4.x** if you require rendering this type of content in your tooltips.

.. _a feature to only include JS/CS in pages where they are used: https://github.com/sphinx-doc/sphinx/pull/8631
.. _may affect the rendering of tooltips: https://github.com/sphinx-doc/sphinx/issues/9115


Tooltip with ``sphinx-tabs``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down