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.

intersphinx links need backreferences_dir

See original GitHub issue

For my intersphinx links (i.e., from examples to API reference) to appear, I had to add

    'backreferences_dir': 'gen_modules/backreferences',
    'doc_module': ('pygsp',),  # pygsp is the name of my package

to my configuration. Is this a bug or an omission in the doc? The doc only mentions those options for mini-galleries (i.e., links to examples).

Issue Analytics

State:
Created 4 years ago
Reactions:1
Comments:7 (5 by maintainers)

Top GitHub Comments

1reaction

DanielAdriaansencommented, Oct 3, 2019

@mdeff thank you for documenting this, I just spent a bunch of time figuring out why my linking to intersphinx documentation wouldn’t work in my examples. This was my problem. When setting backreferences_dir it works!

0reactions

lucyleeowcommented, Apr 27, 2020

Checked in a different build and removing backreferences_dir doesn’t prevent interpshinx linking in examples. I’ll close for now.

Top Results From Across the Web

How to Link to Other Documentation Projects With Intersphinx

Sometimes you may need to link to a specific section of another project's documentation. While you could just hyperlink directly, there is a...

sphinx.ext.intersphinx – Link to other projects' documentation

This extension can generate links to the documentation of objects in external projects, either explicitly through the external role, or as a fallback ......

Intersphinx: easy linking — Sphinx-lesson documentation

There is a common problem: you want to link to documentation in other sites, for example the documentation of list.sort . Isn't it...

Linking Between Sites with Intersphinx - PyCharm Guide

We want to explain Sphinx roles and provide a link to more information. In regular Markdown sites this is very simple. Just do...

How can I put an intersphinx link to an arbitrary method in the ...

I am trying to use Sphinx to document a project, but I cannot figure out how to use intersphinx. I ...