Will Sphinx Work With Code That Doesn't Import Well?
Will the Sphinx documentation engine successfully generate documentation on a project that doesn't import well? In particular my project has an exotic dependency. I don't want do
Solution 1:
If you're using the autodoc extension, then yes, your project must be importable. But sometimes it's possible to mock out dependencies in your conf.py
(since, presumably, at the time of import, the dependencies are needed in name only). The Read the Docs documentation has an example of how to do this.
Post a Comment for "Will Sphinx Work With Code That Doesn't Import Well?"