Skip to content

:ref: does not resolve autosectionlabel #110

Closed
#281
Closed
:ref: does not resolve autosectionlabel#110
#281
Labels
bugSomething isn't working

Description

@daltzctr
daltzctr
opened on Dec 3, 2022

Describe the bug

With the sphinx.ext.autosectionlabel extension installed, it automatically generates references to sections in pages. You would typically reference this section by the following syntax

My :ref:`this is a reference </docs/myarticle:my article section>`

However sphinx design fails to resolve this with undefined label: myarticlesection

Reproduce the bug

  1. Add sphinx.ext.autosectionlabel to your extensions
.. grid:: 2

   .. grid-item-card:: Ref Example
      :link: /docs/myarticle:my section name
      :link-type: ref

List your environment

python = "^3.9"
doc8 = "==0.11.1"
docutils = "==0.17.0"
fonttools = {version = "==4.33.3", extras = ["woff"]}
furo = "==2022.9.29"
latex = "==0.7.0"
packaging = "==20.9"
sphinx = "==4.5.0"
sphinx-hoverxref = "==1.0.1"
sphinx-notfound-page = "==0.8.0"
sphinx_design = "==0.3.0"
sphinxcontrib-ghcontributors = "==0.2.3"
sphinxcontrib-htmlhelp = "==2.0.0"
sphinxcontrib-serializinghtml = "==1.1.5"
sphinxcontrib-svg2pdfconverter = "==1.2.0"
sphinxext-delta = "==0.2.0"
sphinxext-mimic = "==0.1.1"
sphinxext-opengraph = "==0.4.1"
sphinxext-rediraffe = "==0.2.5"
sphinxext-remoteliteralinclude = "==0.3.0"
urllib3 = ">=1.26.6, <2.0.0"

Activity

  1. daltzctr
    added
    bugSomething isn't working
    on Dec 3, 2022

  2. welcome commented on Dec 3, 2022

    @welcome
    welcomebot
    on Dec 3, 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! 🎉

  3. jhj0411jhj commented on Dec 20, 2022

    @jhj0411jhj
    jhj0411jhj
    on Dec 20, 2022

    I write this in my docs. And :ref: goes well:

    extensions += ['sphinx.ext.autosectionlabel']
# Make sure the target is unique
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = None

    the following syntax is shown correctly:

    :ref:`design principle <overview/overview:design principle>`

    But I didn't try grid or link in your problem. Hope this will provide some useful information.

  4. chrisjsewell
    added 5 commits that reference this issue on Jul 12, 2026

    🐛 Fix button-ref target whitespace and nested content

    22feabb

    🐛 Fix button-ref target whitespace and nested content

    7f2dc96

    🐛 Fix button-ref target whitespace and nested content

    eb913e7

    🐛 Fix button-ref target whitespace and nested content

    c6137fa

    🐛 Fix button-ref target whitespace and nested content

    926cc8b
  5. chrisjsewell
    closed this as completedin #281on Jul 14, 2026
  6. chrisjsewell
    added a commit that references this issue on Jul 14, 2026

    🐛 Fix card 🔗 whitespace stripping for ref targets

    ba3f244
  7. hwhsu1231
    added a commit that references this issue on Aug 4, 2026

    🐛 Fix button-ref target whitespace and nested content (executablebook…

    abbf459
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