Skip to content

How do I link to API docs from a notebook? #308

@rabernat

Description

@rabernat

We use autodoc to generate our API docs. I would like to link to these docs from a notebook built by nbsphinx. I read the documentation and examples carefully, but I can't figure out how to do it.

In rst, the reference looks like:

:py:func:`xarray.plot.line`

I would also like to be able to use reference directives like:

:ref:`plotting.multiplelines`

What should I put in my notebook markdown cell to produce such links?

Thanks for the great package.

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