CEMeNT-PSAAP/MCDC

Documentation fails to build starting at #dc54a2b

Closed this issue · 2 comments

Documentation successfully builds at the previous commit, #9cb200f.

Changes were made in #dc54a2b to mcdc/loop.py, mcdc/main.py, mcdc/print_.py, and mcdc/visualizer.py. Not immediately obvious to me why this would change the sphinx functionality at all.
First exception raised:

sphinx.ext.autosummary.ImportExceptionGroup: no module named mcdc.IC_generator

Sphinx was having issue the colorama import added to mcdc/print_.py. It's a documented issue with Sphinx's :autosummary: that when Sphinx runs into an import error, it'll print a "failed to import" warning for the outermost module attempting to import, not the actual import that failed: sphinx-doc/sphinx#7989. Adding a mock directive for colorama in the conf.py file fixes the issue.