Skip to content

New RTD/sphinx build warning #153

@jakkdl

Description

@jakkdl

We recently got a RTD build failure stemming from sphinx-codeautolink, and I'm supremely confused why it started failing just now.

/home/docs/checkouts/readthedocs.org/user_builds/flake8-async/checkouts/335/docs/glossary.rst: WARNING: Could not match transformation of `trio` on source lines 1-1, source:
from trio import CancelScope, lowlevel
# or
# from anyio import CancelScope, lowlevel

with CancelScope(shield=True):
    await lowlevel.checkpoint() [codeautolink.match_name]

generated html is

<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">trio</span><span class="w"> </span><span class="kn">import</span> <a class="sphinx-codeautolink-a" href="https://trio.readthedocs.io/en/latest/reference-core.html#trio.CancelScope" title="trio.CancelScope"><span class="n">CancelScope</span></a><span class="p">,</span> <a class="sphinx-codeautolink-a" href="https://trio.readthedocs.io/en/latest/reference-lowlevel.html#module-trio.lowlevel" title="trio.lowlevel"><span class="n">lowlevel</span></a>

which seems perfectly fine to me. I can repro it locally (clone the repo and run tox -e docs) and viewing the html page it seems identical to previously passing builds.

PR: python-trio/flake8-async#335
failing build: https://readthedocs.org/projects/flake8-async/builds/26766124/
previously passing build: https://readthedocs.org/projects/flake8-async/builds/26677112/

I tried changing the code in the example to see if it was from trio import x, y specifically that made it fail - but I get the same warning with import trio.

I have no clue what changed between these builds, making one fail and not the other. No deps have had new releases, it doesn't seem dependent on specific python versions (RTD builds with 3.13.0, I can repro it locally with py311 and py312). Maybe it's ubuntu-lts-latest and/or RTD, and it's always been failing locally, but...??

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions