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.

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

Remove object entries from TOC #34706

Closed
kwankyu opened this issue Oct 31, 2022 · 13 comments
Closed

Remove object entries from TOC #34706

kwankyu opened this issue Oct 31, 2022 · 13 comments
Labels
c: documentation r: invalid t: bug

Comments

@kwankyu
Copy link
Collaborator

kwankyu commented Oct 31, 2022

We decided to go for #34710 instead of this ticket

Sphinx, upgraded to 5.2.3 in #34615, builds the doc with object (classes, functions, ...) entries in toc (table of contents).

In a sense, this makes our doc broken since new entries are added to toc unintentionally. Original discussion: #34615 comment:22

This tickets reverts the change using a Sphinx configuration variable, also introduced in Sphinx 5.2.3.

Reference:

sphinx-doc/sphinx#10886

Component: documentation

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/34706
@kwankyu kwankyu added this to the sage-9.8 milestone Oct 31, 2022
@kwankyu
Copy link
Collaborator Author

kwankyu commented Oct 31, 2022

Branch: u/klee/remove_objects_definitions_from_toc

@kwankyu
Copy link
Collaborator Author

kwankyu commented Oct 31, 2022

Author: Kwankyu Lee

@kwankyu
Copy link
Collaborator Author

kwankyu commented Oct 31, 2022

Commit: e14c857

@kwankyu
Copy link
Collaborator Author

kwankyu commented Oct 31, 2022

New commits:

e14c857Add toc_object_entries conf variable with False value

@kwankyu

This comment has been minimized.

Sign in to view
@kwankyu

This comment has been minimized.

Sign in to view
@kwankyu

This comment has been minimized.

Sign in to view
@kwankyu kwankyu changed the title Remove objects definitions from TOC Remove object entries from TOC Oct 31, 2022
@kwankyu

This comment has been minimized.

Sign in to view
@kwankyu

This comment has been minimized.

Sign in to view
@kwankyu
Copy link
Collaborator Author

kwankyu commented Nov 3, 2022

Changed author from Kwankyu Lee to none

@kwankyu
Copy link
Collaborator Author

kwankyu commented Nov 3, 2022

Changed commit from e14c857 to none

@kwankyu
Copy link
Collaborator Author

kwankyu commented Nov 3, 2022

Changed branch from u/klee/remove_objects_definitions_from_toc to none

@kwankyu kwankyu removed this from the sage-9.8 milestone Nov 3, 2022
@mkoeppe
Copy link
Contributor

mkoeppe commented Dec 20, 2022

Reviewer: Matthias Koeppe

@mkoeppe mkoeppe closed this as completed Jan 1, 2023
@kwankyu kwankyu mentioned this issue Oct 31, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: documentation r: invalid t: bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kwankyu @mkoeppe