sphinx-design
sphinx-design copied to clipboard
icons not shown correctly in rst toctree
Describe the bug
context When I write icons in rst toctree:
.. toctree::
:caption: Table of content
:maxdepth: 2
:titlesonly:
Quick Start :octicon:`rocket;1em` <quick_start/quick_start>
expectation I expected icon to occur in the side bar.
bug But instead the raw text is shown.
Reproduce the bug
write toctree as above
List your environment
myst-parser 0.18.1
furo 2022.12.7
pydata-sphinx-theme 0.8.1
sphinx-basic-ng 1.0.0b1
sphinx-book-theme 0.3.3
sphinx-copybutton 0.5.1
sphinx_design 0.3.0
sphinx-hoverxref 1.3.0
sphinx-notfound-page 0.8.3
sphinx-rtd-theme 1.1.1
sphinxcontrib-applehelp 1.0.2
sphinxcontrib-devhelp 1.0.2
sphinxcontrib-htmlhelp 2.0.0
sphinxcontrib.jquery 3.0.0
sphinxcontrib-jsmath 1.0.1
sphinxcontrib-qthelp 1.0.3
sphinxcontrib-serializinghtml 1.1.5
Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:
I just came here to report the same thing. Would be GREAT to get this working.
I suspect that this has the same root cause as #66, namely it is a limitation of sphinx that has been raised upstream (https://github.com/sphinx-doc/sphinx/issues/8068) and milestoned for "some future version" of sphinx (i.e., probably not supported anytime soon)