ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
205 stars 38 forks source link

Ignore ModuleNotFoundError #53

Closed mattjacobs23 closed 1 year ago

mattjacobs23 commented 1 year ago

I have added certain external modules to the --ignored-modules flag, however lazydocs still fails to generate docs for my modules which leverage these external modules, giving a ModuleNotFoundError. My modules depend on many other libraries which are enterprise-specific and cannot be pip installed easily, especially when using a virtual machine with GitHub Actions to run my MkDocs logic. I do not want to have to import all of these just for lazydocs. I am only trying to generate some very basic documentation for my own library, I am fine with not providing further information on the external libraries we are leveraging. Can I have an option of simply bypassing these ModuleNotFoundErrors, where the markdown is still generated just without information for the uninstalled external modules?