Skip to content

First order header in each API doc page is broken #26679

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.

Sign up for GitHub

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

Jump to bottom
Closed
glemaitre opened this issue Jun 23, 2023 · 0 comments · Fixed by #26680
Closed

First order header in each API doc page is broken #26679

glemaitre opened this issue Jun 23, 2023 · 0 comments · Fixed by #26680
Assignees
@glemaitre

Comments

@glemaitre
Copy link
Member

By introducing #26625, we broke the rendering of the API documentation: the name of the class/function on the top of the page is not displayed as a header anymore.

It seems to be related to the following Sphinx bug: sphinx-doc/sphinx#11437

I am going to investigate how to solve this problem.
@github-actions github-actions bot added the Needs Triage Issue requires triage label Jun 23, 2023
@glemaitre glemaitre changed the title Header in documentation API is broken First order header in each API doc page is broken Jun 23, 2023
@glemaitre glemaitre removed the Needs Triage Issue requires triage label Jun 23, 2023
@glemaitre glemaitre self-assigned this Jun 23, 2023
@glemaitre glemaitre mentioned this issue Jun 23, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@glemaitre glemaitre

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

FIX workaround sphinx limitation with rst_prolog glemaitre/scikit-learn
1 participant
@glemaitre