sphinx-autoapi icon indicating copy to clipboard operation
sphinx-autoapi copied to clipboard

How to cross-reference to `sphinx-autoapi` generated pages?

Open michaelweinold opened this issue 9 months ago • 0 comments

How can I cross reference to the documentation of a specific function, which has been generated by sphinx-autoapi? We are using markdown (through the MyST parser) in our documentation - so I am looking for the markdown syntax.

For instance, I would like to link to this function in our documentation from a markdown page.

While it was suggested to use a command along the lines of:

:obj:bw2data.project.ProjectManager.copy_project`

but unfortunately, this did not work - and I could not find any documentation on the obj role in the MyST cross-referencing documentation.

michaelweinold avatar May 06 '24 19:05 michaelweinold