neo-mamba icon indicating copy to clipboard operation
neo-mamba copied to clipboard

api reference doc issues

Open ixje opened this issue 2 years ago • 0 comments

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
  • [x] 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

ixje avatar Nov 28 '22 19:11 ixje