Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

icons not shown correctly in rst toctree #117

Open
jhj0411jhj opened this issue Dec 20, 2022 · 3 comments
Open

icons not shown correctly in rst toctree #117

jhj0411jhj opened this issue Dec 20, 2022 · 3 comments
Labels
bug Something isn't working

Comments

@jhj0411jhj
Copy link

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
@jhj0411jhj jhj0411jhj added the bug Something isn't working label Dec 20, 2022
@welcome
Copy link

welcome bot commented Dec 20, 2022

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

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! 🎉

@guideloom
Copy link

I just came here to report the same thing. Would be GREAT to get this working.

@drammock
Copy link

I suspect that this has the same root cause as #66, namely it is a limitation of sphinx that has been raised upstream (sphinx-doc/sphinx#8068) and milestoned for "some future version" of sphinx (i.e., probably not supported anytime soon)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants