Skip to content

DOC: Fix cross-referencing to API methods and functions  #2448

@VeckoTheGecko

Description

@VeckoTheGecko

Unfortunately, I am only able to refer to classes, and not their methods, i.e. the following doesn’t create the link to the method:

I dug a bit deeper into this, I also couldn't get it to link to methods either with the current setup - though I think that's due to our current config.

I tested the following

## works
{py:obj}`parcels.ParticleSet` 
{py:class}`parcels.ParticleSet`

## broken
{py:meth}`parcels.ParticleSet.execute` 
{py:meth}`parcels._core.particleset.ParticleSet.execute` 
{py:obj}`download_example_dataset`

On the https://myst-parser.readthedocs.io/en/latest/syntax/code_and_apis.html#sphinx-autodoc2 page it has the following example

- {py:obj}`myst_parser.sphinx_ext.main.setup_sphinx`
- [](#myst_parser.sphinx_ext.main.setup_sphinx)

which properly links to a function. I think the solution might be in the fact that they're using autodoc2 instead of autodoc (maybe the way that generates references is different to what we have).

Should I make this into a separate issue to be pursued later @erikvansebille ? I think cross linking with the classes is suitable for now/a bit lower on the chopping block

Originally posted by @VeckoTheGecko in #2442 (comment)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Done

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions