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

Remove toc warnings #34262

Closed
kwankyu opened this issue Aug 2, 2022 · 18 comments
Closed

Remove toc warnings #34262

kwankyu opened this issue Aug 2, 2022 · 18 comments

Comments

@kwankyu
Copy link
Collaborator

kwankyu commented Aug 2, 2022

Part of #33833. Fix

We add :class: like

.. contents::
   :class: this-will-duplicate-information-and-it-is-still-useful-here

to remove the furo's warning, since those toc's are useful for pdf docs and not bad even for html docs.

Depends on #34252

Component: documentation

Author: Kwankyu Lee

Branch: 16cbb44

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/34262

@kwankyu kwankyu added this to the sage-9.7 milestone Aug 2, 2022
@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 2, 2022

Branch: u/klee/remove_toc_warnings

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 2, 2022

Commit: 49a9316

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 2, 2022

Author: Kwankyu Lee

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 2, 2022

Last 10 new commits:

f19b597Add link to the logo
09d5f5cFix the logo link for reference
ae75d53Fix a subtle reference problem for build_options
3519bedRun docbuild workflow with single thread
1274718Fix a suspicious part of categories doc
e5b1f7eAdd search.html
ebd3b77Better pygments style
73e5aa3Make white logo transparent to match with furo
183e558Merge branch 'develop' into t/34252/revive-furo
49a9316Remove toc warnings

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 2, 2022

Dependencies: #34252

@kwankyu

This comment has been minimized.

@kwankyu

This comment has been minimized.

@mkoeppe
Copy link
Contributor

mkoeppe commented Aug 2, 2022

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 2, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

16cbb44Take care of a missed toc directive

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 2, 2022

Changed commit from 49a9316 to 16cbb44

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 2, 2022

comment:9

While working on this ticket, I experienced ./configure --enable-editable, which is the default now. I needed to search the whole src/doc directory and subdirectories, but then since the src tree was cluttered with lots of build artifacts, the search would take much more time. Hence I did ./configure --disable-editable to go back to the "normal" state of the src tree. From my experience, I doubt if the new default is really good for developers...

@mkoeppe
Copy link
Contributor

mkoeppe commented Aug 2, 2022

comment:11

It may need some time to get used to it coming from longstanding Sage practice, but editable builds are the standard way to develop in the Python world

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 2, 2022

comment:12

Replying to @mkoeppe:

but editable builds are the standard way to develop in the Python world

Okay.

@mkoeppe
Copy link
Contributor

mkoeppe commented Aug 3, 2022

Reviewer: Matthias Koeppe

@vbraun
Copy link
Member

vbraun commented Aug 6, 2022

Changed branch from u/klee/remove_toc_warnings to 16cbb44

@tobiasdiez
Copy link
Contributor

Changed commit from 16cbb44 to none

@tobiasdiez
Copy link
Contributor

comment:15

Would it be possible to only display the toc in the pdf? In my opinion, they just duplicate information that is already displayed in the right column.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Aug 7, 2022

comment:16

Replying to @tobiasdiez:

Would it be possible to only display the toc in the pdf? In my opinion, they just duplicate information that is already displayed in the right column.

They are duplicated but often a short version of the full toc on the right column, and hence they are still useful. So I think it is not worth the effort to try to find a way to show them only in the pdf.

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

4 participants