sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code
http://sphinxcontrib-matlabdomain.readthedocs.io/
Other
69 stars 45 forks source link

Documentation no longer building successfully with matlabdomain #188

Closed kbonney closed 1 year ago

kbonney commented 1 year ago

Hello matlabdomain devs, Thank you for your work on this useful extension.

Recently, the documentation for NuMAD has been failing to build. On RTD, the build fails due to a timeout error. When I build locally I get the same issue - but I am able to keyboard interrupt (CTRL-C) to get more information. Here is a pastebin for the full log.

I checkout out the last commit that passed the documentation, and attempted to build the documentation - but I encountered the same issue as above. We have pinned the python dependencies used for building the docs, so I am unsure why a previously building commit would no longer build under the same conditions. We have been using an old version of matlabdomain, so I attempted to build the documentation (still on the last working commit) using the latest release (0.19.0) and I get a different error log which can be read here. Unpinning all requirements and letting pip install the latest compatible versions results in a nearly identical error log.

I am not sure how to interpret these error logs - so any advice on how to proceed would be appreciated. Please let me know what other information I can provide. Best, Kirk

joeced commented 1 year ago

That looks odd. I'll try to build the docs on my own, to identify the issue. I found a few bugs in version 0.19.0 (among other a possible endless loop), and released 0.19.1 last week.

joeced commented 1 year ago

Findings:

We will try to fix this ASAP.

kbonney commented 1 year ago

Thanks for the update. Will stand by for the bug-fix.

joeced commented 1 year ago

Fixed in version 0.20.0rc1.