search

EIT-ALIVE / eitprocessing

Software for electrical impedance tomography data loading, visualization and processing
https://eit-alive.github.io/eitprocessing/
Apache License 2.0
5 stars 0 forks source link

autodoc / autoapi module table of contents is mixed up #91

Open psomhorst opened 1 year ago

psomhorst commented 1 year ago

When Sphinx autodoc / autoapi creates domentation, the table of contents should group the content by classes, attributes etc. For an unknown reason, when a module contains both classes and attributes, the classes are listed under attributes in the table of contents. This is the case in the current documentation of #88, the module eitprocessing.filters.butterworth_filters. When a module only contains classes, they are listed properly (eitprocessing.binreader or eitprocessing.filters).

This issue persists between themes.

This issue might be related to https://github.com/sphinx-doc/sphinx/issues/11180.

spreiter commented 3 months ago

I fixed this with a new config parameter. Maybe this helps as well.

https://github.com/sphinx-doc/sphinx/issues/11180#issuecomment-2271845097