Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to reference AutoAPI pages #507

Open
Koen1999 opened this issue Dec 18, 2024 · 0 comments
Open

How to reference AutoAPI pages #507

Koen1999 opened this issue Dec 18, 2024 · 0 comments

Comments

@Koen1999
Copy link

I couldn't find any information regarding this in the documentation, but I would like to reference a page generated by AutoAPI from a written MarkDown file Sphinx parses via MyST. It seems like it should be possible to do this somehow, but I did not find any suggestions on how to do this. I am trying to reference the more detailed documentation generated by AutoAPI from the README.

I tried the following: [Module API Reference](./autoapi/package/module) which does not work.

Of course I could use an absolute link, but that seems like an anti-pattern.

Did anyone ever try to address this neatly before?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant