Skip to content
forked from pwwang/mkapi

A documentation generation tool for MkDocs.

License

Notifications You must be signed in to change notification settings

stjordanis/mkapi

 
 

Repository files navigation

mkapi-fix

A fork of mkapi with a couple of fixes that fit my use

Note that those fixes may not make sense for your case

Install

pip install mkapi-fix
# make sure you only have mkapi or mkapi-fix installed

Fixes/Modifications

  • Fix when module prefix is None
  • Skip __wrapped__ check if errored
  • Fix when decorators return the same object
  • Fix when annotations.__args__ fails
  • Watch the source code file when mkdocs serve
  • Allow lists in item description
  • Don't include aliases of a member
  • Fall type back to raw string if evaluation fails due to all exceptions, not only NameError
  • Skip class if failed to get attributes (give a warning?)
  • Skip members when fail when warnings

About

A documentation generation tool for MkDocs.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 90.7%
  • CSS 5.5%
  • Jinja 3.7%
  • JavaScript 0.1%