Skip to content

toctree skips an entry if its title begins with an inline icon directive #99

Description

@demberto

Describe the bug

Using one of the directives specified over at https://sphinx-design.readthedocs.io/en/furo-theme/badges_buttons.html#inline-icons at the start of a title included in a toctree makes it look small and is skipped by the toctree

image
image

However, if I append a trailing backslash (as given below). it works perfectly:

image
image

Reproduce the bug

./index.rst:

.. toctree::

   abc

./abc.rst

:fas:`bars-staggered` Understanding descriptors
===============================================

List your environment

Python 3.10.7 venv
Windows 10 64bit

> pip freeze
alabaster==0.7.12
apeye==1.2.0
appdirs==1.4.4
astroid==2.12.9
attrs==22.1.0
autodocsumm==0.2.9
Babel==2.10.3
bandit==1.7.4
beautifulsoup4==4.11.1
black==22.8.0
build==0.8.0
bytesioex==0.1.2
CacheControl==0.12.11
certifi==2022.6.15.1
charset-normalizer==2.1.1
click==8.1.3
colorama==0.4.5
colour==0.1.5
cssutils==2.6.0
dict2css==0.3.0
dill==0.3.5.1
distlib==0.3.6
docutils==0.18.1
dodgy==0.2.1
domdf-python-tools==3.4.0
esbonio==0.14.1
filelock==3.8.0
flake8==5.0.4
flake8-docstrings==1.6.0
flake8-polyfill==1.0.2
flake8-typing-imports==1.13.0
furo==2022.6.21
gitdb==4.0.9
GitPython==3.1.27
html5lib==1.1
idna==3.3
imagesize==1.4.1
iniconfig==1.1.1
isort==5.10.1
Jinja2==3.1.2
lazy-object-proxy==1.7.1
livereload==2.6.3
lockfile==0.12.2
m2r2==0.3.2
Markdown==3.4.1
markdown-it-py==2.1.0
MarkupSafe==2.1.1
mccabe==0.7.0
mdit-py-plugins==0.3.0
mdurl==0.1.2
mistune==0.8.4
msgpack==1.0.4
mypy-extensions==0.4.3
myst-parser==0.18.0
natsort==8.2.0
packaging==21.3
pathspec==0.10.1
pbr==5.10.0
pep517==0.13.0
pep8-naming==0.10.0
platformdirs==2.5.2
pluggy==1.0.0
py==1.11.0
pycodestyle==2.9.1
pydantic==1.9.2
pydocstyle==6.1.1
pyflakes==2.5.0
-e git+https://github.com/demberto/PyFLP.git@44e18203ebbe6ce75b1366d5e647783cea5a9d87#egg=pyflp
pygls==0.12.1
Pygments==2.13.0
pylama==8.4.1
pylint==2.15.2
pylint-celery==0.3
pylint-django==2.5.3
pylint-flask==0.6
pylint-plugin-utils==0.7
pyparsing==3.0.9
pyspellchecker==0.7.0
pytest==7.1.3
pytest-lazy-fixture==0.6.3
pytz==2022.2.1
PyYAML==6.0
requests==2.28.1
requirements-detector==0.7
ruamel.yaml==0.17.21
ruamel.yaml.clib==0.2.6
setoptconf-tmp==0.3.1
six==1.16.0
smmap==5.0.0
snowballstemmer==2.2.0
soupsieve==2.3.2.post1
Sphinx==5.1.1
sphinx-autobuild==2021.3.14
sphinx-autodoc-typehints==1.19.2
sphinx-basic-ng==0.0.1a12
sphinx-copybutton==0.5.0
sphinx-hoverxref==1.1.3
sphinx-jinja2-compat==0.2.0
sphinx-prompt==1.5.0
sphinx-tabs==3.4.1
sphinx-toolbox==3.2.0
sphinx_design==0.3.0
sphinx_inline_tabs==2022.1.2b11
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-images==0.9.4
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
stevedore==4.0.0
tabulate==0.8.10
toml==0.10.2
tomli==2.0.1
tomlkit==0.11.4
tornado==6.2
tox==3.26.0
typeguard==2.13.3
typing_extensions==4.3.0
urllib3==1.26.12
virtualenv==20.16.5
webencodings==0.5.1
wrapt==1.14.1

My repo is at https://github.com/demberto/PyFLP

Activity

  1. welcome commented on Sep 26, 2022

    @welcome

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

  2. added a commit that references this issue on Aug 4, 2026
    220407d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions