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

Types in the apidoc documentation #2

Closed
rlaugier opened this issue Jul 31, 2024 · 2 comments
Closed

Types in the apidoc documentation #2

rlaugier opened this issue Jul 31, 2024 · 2 comments

Comments

@rlaugier
Copy link
Owner

At the moment, having a module type hint translates into the documentation into giving the url of the module source on my machine.
This should be fixed asap.

@rlaugier
Copy link
Owner Author

rlaugier commented Aug 8, 2024

I tried to run apidoc more cleanly, with a recent interface. It is currently failing spectacularly. I'm not sure but I suspect it is a problem of compatibility of our way of using type hints and the apidoc code.
I have opened an issue on their github here

@rlaugier
Copy link
Owner Author

This is solved with commit 23418b9

Idenitfied a problem where autoapi crashes when working with a type imported directly from a package.

Instead I make a reference to the type directly through the imported module's namespace, and it works fine. This only leads to a couple of unusual lines in the imports, but acceptable. We may revisit when the issue is fixed on the side of autoapi

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