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

Commit 797e7ff

Browse files
authored
Merge pull request #124 from readthedocs/humitos/note-about-sphinx-3.5
Docs: mention that Sphinx>=3.5 may not work with dynamic content
2 parents 22e5e1b + 96d54a9 commit 797e7ff

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/usage.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,15 @@ These actions are usually calling a Javascript function.
9393
``hoverxref`` is prepared to support this type of content and currently supports rendering
9494
`sphinx-tabs`_ and mathjax_.
9595

96+
.. warning::
97+
98+
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.
99+
This `may affect the rendering of tooltips`_ that includes content requiring extra rendering steps.
100+
**Make sure you are using Sphinx 3.4.x** if you require rendering this type of content in your tooltips.
101+
102+
.. _a feature to only include JS/CS in pages where they are used: https://github.com/sphinx-doc/sphinx/pull/8631
103+
.. _may affect the rendering of tooltips: https://github.com/sphinx-doc/sphinx/issues/9115
104+
96105

97106
Tooltip with ``sphinx-tabs``
98107
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)