search

cta-observatory / ctapipe

Low-level data processing pipeline software for CTAO or similar arrays of Imaging Atmospheric Cherenkov Telescopes
https://ctapipe.readthedocs.org
BSD 3-Clause "New" or "Revised" License
63 stars 266 forks source link

ctapipe.io sidebar links same(?) pages twice #2449

Open Tobychev opened 8 months ago

Tobychev commented 8 months ago

Describe the bug The sidebar menu for ctapipe.io contains repeated entries, for example TableReader. It looks like there's some automatic namespace processing that goes wrong.

To Reproduce Go to https://ctapipe.readthedocs.io/en/latest/api/ctapipe.io.tableio.TableReader.html and compare it with https://ctapipe.readthedocs.io/en/latest/api/ctapipe.io.TableReader.html

Expected behaviour That there should only be one entry per module, or if there are several modules with the same name that they should be in separate sections also in the sidebar.

maxnoe commented 8 months ago

This is because we include multiple modules on the same page of the documentation. This means that the original definition of a class (e.g. ctapipe.io.tableloader.TableLoader and the user facing export (e.g. ctapipe.io.TableLoader) are rendered twice.

A solution would be to copy the hierarchy of the modules in the documentation pages and not include tableloader in io