search

pik-copan / pyunicorn

Unified Complex Network and Recurrence Analysis Toolbox
http://pik-potsdam.de/~donges/pyunicorn/
Other
195 stars 87 forks source link

DOC: sphinx `Didn't find <class attribute> in <module>` when building docs #220

Open fkuehlein opened 6 months ago

fkuehlein commented 6 months ago

class added in #156, but missing in docs/source/api/climate

fkuehlein commented 3 months ago

while at it, might also look into countless cases like

reading sources... [ 50%] api/core/network
Didn't find Network.N in pyunicorn.core.network

when building docs.

This happens for class attributes only, not for class methods. Yet, all attributes appear alright in the built documentation, so it doesn't cause an actual issue. Using .. autoclass:: instead of .. automodule:: e.g. in api/core/network.rst will fix the warning, but doesn't really apply here as we want to document modules.

fkuehlein commented 3 months ago

The original issue has been resolved as of #232, but the issue in the above comment persists, although it is only a matter of having a clean build log.