Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Tobychev opened this issue Nov 6, 2023 · 1 comment
Open

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

Tobychev opened this issue Nov 6, 2023 · 1 comment

Comments

@Tobychev
Copy link
Contributor

Tobychev commented Nov 6, 2023

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
Copy link
Member

maxnoe commented Nov 10, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants