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

Table of Contents issue in API doc pages #2144

Closed
josephmure opened this issue Sep 27, 2022 · 7 comments
Closed

Table of Contents issue in API doc pages #2144

josephmure opened this issue Sep 27, 2022 · 7 comments
Milestone

Comments

@josephmure
Copy link
Collaborator

The current master has very ugly API TOCs:

https://openturns.github.io/openturns/master/user_manual/_generated/openturns.ConditionalDistribution.html

image

This bug was not introduced by PR #2136, as the CircleCI-compiled doc of that PR shows:

https://output.circle-artifacts.com/output/job/994fb343-d924-4b6d-9fc9-c0186f62f674/artifacts/0/html/user_manual/_generated/openturns.ConditionalDistribution.html

image

Did something change with Sphinx?

@josephmure josephmure added the doc label Sep 27, 2022
@jschueller
Copy link
Member

yes, the version: 5.2.x

@josephmure
Copy link
Collaborator Author

Can you fix this before the RC or should we freeze the Sphinx version for now?

@jschueller
Copy link
Member

jschueller commented Sep 27, 2022

at least open an issue at sphinx with the same report please

@jschueller
Copy link
Member

jschueller commented Sep 28, 2022

looks it comes from sphinx-doc/sphinx#10807

@josephmure
Copy link
Collaborator Author

I have raised the issue in the discussion of the request that prompted the creation of the feature that is causing the problem: sphinx-doc/sphinx#6316 (comment)

@josephmure josephmure changed the title Ugly Table of Contents in API doc pages Table of Contents issue in API doc pages Sep 29, 2022
@josephmure
Copy link
Collaborator Author

josephmure commented Sep 29, 2022

The option to disable the feature is implemented in PR sphinx-doc/sphinx#10886 (intended for sphinx 5.2.3). I have tested it locally: it works fine.

To disable the feature, we will need to add the following line to conf.py.in:

toc_object_entries = False

@josephmure
Copy link
Collaborator Author

We might want to think about updating the "openturns" theme, however.

jschueller added a commit to jschueller/openturns that referenced this issue Sep 30, 2022
@jschueller jschueller mentioned this issue Sep 30, 2022
@jschueller jschueller added this to the 1.20 milestone Sep 30, 2022
jschueller added a commit to jschueller/openturns that referenced this issue Oct 1, 2022
jschueller added a commit to jschueller/openturns that referenced this issue Oct 1, 2022
jschueller added a commit to jschueller/openturns that referenced this issue Oct 1, 2022
jschueller added a commit to jschueller/openturns that referenced this issue Oct 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants