search

sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code
Other
64 stars 45 forks source link

documenter.generate() being called multiple times for module #242

Closed rdzman closed 5 months ago

rdzman commented 5 months ago

In the process of debugging an auto-link issue, I noticed some behavior that looks questionable.

When documenting a number of functions or classes in a given module, it appears the generate() method of the documenter (and therefore the auto-linking code) is called for the module for every single class and function. This means the documentation for the module is processed many, many times.

Is this a bug?

rdzman commented 5 months ago

Sorry, nevermind ... I think it comes from me using .. automodule:: where I should be using .. currentmodule::.

I'll re-open this if that conclusion turns out to be incorrect.