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

tqdm progressbar output messy in documentation #312

Closed
OnnoEbbens opened this issue Jan 4, 2024 · 6 comments
Closed

tqdm progressbar output messy in documentation #312

OnnoEbbens opened this issue Jan 4, 2024 · 6 comments

Comments

@OnnoEbbens
Copy link
Collaborator

The documentation looks kind of messy because intermediate status of the progress bar is shown:

image

A fix might be to disable the progress bar when creating the documentation by setting an environment variable with TQDM_DISABLE=1, see also: tqdm/tqdm#1061

@rubencalje
Copy link
Collaborator

Hmm, this used to be prettier:

image

What did we change?

@dbrakenhoff
Copy link
Collaborator

Maybe I changed from tqdm import tqdm to from tqdm.auto import tqdm?

But the latter option does make things much prettier for users running notebooks, with less red highlighting and such.

@rubencalje
Copy link
Collaborator

Maybe I changed from tqdm import tqdm to from tqdm.auto import tqdm?

But the latter option does make things much prettier for users running notebooks, with less red highlighting and such.

I do not think that is the problem, as we still use from tqdm import tqdm I think. But it may be the solution?

@rubencalje
Copy link
Collaborator

Another import-method is no solution, I found out from testing. I think the problem has to do with the nbconvert version. Since nbconvert version 7.14 the output is messy. See jupyter/nbconvert#2092

I will fix the nbsphinx version to 7.13 for now, and hope this will make thoe output pretty again,

@rubencalje
Copy link
Collaborator

Adding ipywidgets to the dependencies was also necessary.

I also made these two small changes to the main-branch, as I hoped this would fix the stable documentation as well. This is not the case, however. Then I made a branch named 'stable', which according to some webpages would fix it. This is also not the case. Finally, I temporarily set the default docs-page to the latest-version, from stable. We should change this back after the next release.

@OnnoEbbens
Copy link
Collaborator Author

fixed in the dev branch

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

No branches or pull requests

3 participants