Skip to content

Specify Target of reference_url #947

@ExtremOPS

Description

@ExtremOPS

Hi there,

we are using sphinx-gallery for our OSAFT project and are very happy 😸

I wanted now to add the option of reference_url and did so by adding

# sphinx_gallery
sphinx_gallery_conf = {
    ...
    # Modules for which function/class level galleries are created.
    'doc_module': ('osaft'),
    'reference_url': {
        'osaft': None,
    },
}

For some reasons the inheritance diagram for the classes of interest look like this:

image

The common feature is that all ARF classes inherit from BaseARF. The issue that I have is visible here. In the code block where it reads

 yosioka = osaft.yosioka1955.ARF(
     frequency=f,
     radius=R_0,
     ...
)

Does a "click" on osaft.yosioka1955.ARF, osaft.gorkov1962.ARF, or osaft.settnes2012.ARF transfer you to the documentation page of osaft.solutions.BaseARF instead of the anticipated osaft.solutions.yosioka1955.ARF.

I hope that I expressed the issue well enough! Is there a possibility to set the depth of the reference or similar.

Otherwise, I am also happy to add a patch enabling it if you could point me to the lines of code where this would need to be implemented.

Than you very much in advance,
Christoph

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions