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.

Sign up for GitHub

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

Jump to bottom

api reference doc issues #232

Open

1 of 6 tasks

ixje opened this issue Nov 28, 2022 · 0 comments

Labels

Member

ixje commented Nov 28, 2022 •

edited

Loading

List of known issues with mkapi we need to patch to improve the generated documentation

typing.Optional are not parsed correctly. It only shows Optional not the containing type
See Also links are not resolved correctly when referencing another document
Enum's do not show its members, but instead show all internal/inherited methods that are not useful
add ability to filter unwanted modules
Does not understand typing.Sequence, only shows Sequence not the containing type.
class attributes are not documented

The text was updated successfully, but these errors were encountered:

ixje added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment