question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

reference_url failure in sphinx version > 5

See original GitHub issue

After sphinx released version 5, reference_url in sphinx_gallery_conf section gives the following error upon doc build:

Extension error (sphinx_gallery.docs_resolv):
Handler <function embed_code_links at 0x7fe9e0a40820> for event 'build-finished' threw an exception (exception: Expecting property name enclosed in double quotes: line 1 column 2 (char 1))

As far as I could address, for reference_url http://example.com/stable/"in conf.py, /"at the end is treated as escape and removed. If the url is specified as http://example.com, then the following error occurs:

embedding documentation hyperlinks...
WARNING: The following HTTPError has occurred fetching http://example.com/stable_static/documentation_options.js: 404 (Not Found)

The second case can be avoided in https://github.com/sphinx-gallery/sphinx-gallery/blob/e7d7439f6b85c603801945dd9ab510217cd9a269/sphinx_gallery/docs_resolv.py#L153 .

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
ntessorecommented, Aug 11, 2022

Just checking in to report that v0.11.0 still has problems with None entries in reference_url.

0reactions
bouthilxcommented, Sep 2, 2022

I am having the same issue with 'reference_url': {'sphinx_gallery': None}. Downgrading sphinx to v4.5.0 solves the issue for sphinx-gallery<=0.11.0.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Changelog - Sphinx documentation
#10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing Node.findall() ... #9434: sphinxcontrib-serializinghtml-1.1.5 or above ...
Read more >
Sphinx Documentation - Read the Docs
20.17 Release 1.6.5 (released Oct 23, 2017) . ... [Ref] Book or article reference, URL or whatever. Citation usage is similar to footnote ......
Read more >
Pinning sphinx version sometimes fails · Issue #5810 - GitHub
Details I am attempting to set up RTD to build documentation for a project using a bunch of the pydata tools.
Read more >
sphinx-build fail - autodoc can't import/find module
I have index.rst in /docs/source and /ys_utils . I'm guessing this should be in the docs version? I ...
Read more >
Cross-referencing with Sphinx - Read the Docs
URL links only work for the html version of your documentation. Instead, Sphinx ... Cross referencing in Sphinx uses two components, references and...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found