Override package/module discovery in page mode to load file even if no docstring is present

daizutabi / mkapi

A plugin for MkDocs to generate API documentation

https://daizutabi.github.io/mkapi/

MIT License

95 stars 19 forks source link

Override package/module discovery in page mode to load file even if no docstring is present #42

Closed JosXa closed 7 months ago

JosXa commented 3 years ago

In the docs, it says:

For Python files that contain only a single class however, adding a docstring feels kind of unnecessary and redundant. Is it possible to override this functionality and force loading files even if they have no docstring? My current workaround is to add a docstring with invisible character, which kinda works but creates too much blank space in the docs:

daizutabi commented 3 years ago

In Version 1.0.14, MkApi processes packages/modules if their members (class/function) have docstring.