MAINT: Fix for Sphinx 7.2

[larsoner]

Closes #1175

[pllim]

Hi! Does this patch also fix this error I am seeing downstream with Sphinx 7.2.2 and sphinx-gallery 0.13.0 ?

Traceback (most recent call last):
  File "sphinx/events.py", line 96, in emit
    results.append(listener.handler(self.app, *args))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "sphinx_gallery/docs_resolv.py", line 471, in embed_code_links
    _embed_code_links(app, gallery_conf, gallery_dir)
  File "sphinx_gallery/docs_resolv.py", line 324, in _embed_code_links
    doc_resolvers[this_module] = SphinxDocLinkResolver(
                                 ^^^^^^^^^^^^^^^^^^^^^^
  File "sphinx_gallery/docs_resolv.py", line 146, in __init__
    if doc_url.startswith(('http://', 'https://')):
       ^^^^^^^^^^^^^^^^^^
AttributeError: 'PosixPath' object has no attribute 'startswith'

Example log: https://readthedocs.org/projects/astropy/builds/21642243/ (from astropy/astropy#15185)

[larsoner]

Nope, but I can open a quick PR for you to test

[larsoner]

... actually it looks like that was fixed before this PR, so master should work already

[pllim]

In that case, what is the timeline to release sphinx-gallery?

[larsoner]

None at the moment. In theory we should release given the breakages I guess! You can use for example pip install git+https://github.com/sphinx-gallery/sphinx-gallery.git@309e5be03088410e495c32272edd09cc9548e50c to work around 7.2 errors for now

[larsoner]

@lucyleeow WDYT about cutting a release?

[pllim]

I want to avoid pinning our infrastructure to unreleased sphinx-gallery if possible, so I can pin sphinx<7.2 until a new release is available.

[pllim]

Just to report back that using the dev version of sphinx-gallery + sphinx 7.2.2 , I got a green RTD build, so I am looking forward to your release. Thanks!

xref astropy/astropy#15184

[lucyleeow]

Thanks @larsoner ! I was wondering how the docname change came about but could not find a specific source, maybe it was part of the move from str to Path?

[lucyleeow]

@lucyleeow WDYT about cutting a release?

Sorry I don't think I will have time for that. I will fix my PRs though so they get in.

[pllim]

From the looks of https://github.com/sphinx-gallery/sphinx-gallery/blob/master/.github/workflows/release.yml , anyone with maintainer access should be able to release?

p.s. You don't need to upload/download artifact unless you are building architecture specific wheels, which I don't think you are.

[lucyleeow]

@larsoner I've done some labelling to make release easier for you. Thank you 🙏

[larsoner]

I saw that on your PRs, much appreciated :)

I'll look into releasing now, indeed with the release.yml I think it's pretty quick I think...

[larsoner]

https://pypi.org/project/sphinx-gallery/0.14.0/