Thanks to visit codestin.com
Credit goes to github.com

Skip to content

No examples file generates for aliases #365

@ImportanceOfBeingErnest

Description

It seems sphinx-gallery has a problem with aliases and does not produce any example file for them?

class Foo(object):
    """
    Foo is used for fooing and provides fooing methods
    """

AliasOfFoo = Foo

This would result in an example file Foo.examples being created. But no AliasOfFoo.examples.
However, since Sphinx generates an automodule rst page for both classes the AliasOfFoo.rst tries to include AliasOfFoo.examples via .. include:: AliasOfFoo.examples.
Finally this results in an error

Problems with "include" directive path: 
InputError: No such file or directory: .../AliasOfFoo.examples

This problem occurs in the case of the matplotlib documentation (matplotlib/matplotlib#11079), e.g. mpl_toolkits/axes_grid1/axes_grid.py#L770.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions