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

Set lower default verbosity and add config options. #150

Merged
merged 2 commits into from
Mar 19, 2024

Conversation

Carreau
Copy link
Collaborator

@Carreau Carreau commented Mar 19, 2024

I think this should cover most of the cases.

See #149

I think this shoudl cover most of the cases.
Copy link
Collaborator

@steppi steppi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks @Carreau. Just some minor comments on the documentation.

Comment on lines 68 to 83
## Build logging levels

Jupyterlite-sphinx exposes jupyterlite debug and logging flags thought the
following configuration options.


- `jupyterlite_debug`, boolean (`False`|`True`), passes the `--debug` flag to
`jupyterlite build`

It also has the following configuration options:

- `jupyterlite_log_level`, a `str`, default to `"WARN"` or `None`
- `jupyterlite_verbosity` a `str`, default to `"0"` or `None`
- `jupyterlite_reporter` a `str`, default to `"zero"` or `None`

Jupyterlite-sphinx decreases verbosity by deafult, these can be set to `None` to restore the jupyterlite default.
Copy link
Collaborator

@steppi steppi Mar 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should mention verbosity controls the verbosity setting of doit which is used in jupyterlite, and link to the doit config docs, https://smarie.github.io/python-doit-api/api_reference/.

And also mention that jupyterlite_log_level controls the log_level for jupyterlite build itself. I can't find --log-level in the jupyterlite docs though.

It's also unclear to me what "default to "Warn" or "None"" etc. means
Maybe just "defaults to "Warn" etc.? And then just mention that setting these values to None gives the defaults?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, I get it now. i think I'd understand if it was something like

a str (defaults to "WARN") or None

docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
@steppi steppi merged commit 4dd4b30 into jupyterlite:main Mar 19, 2024
5 checks passed
@steppi
Copy link
Collaborator

steppi commented Mar 19, 2024

I fixed the docs and merged it since I want to get this in ASAP since its causing serious trouble in SciPy. I plan to make a release now.

@matthewfeickert
Copy link

This resolves Issue #106 as this changes the expected type from PosixPath to str.

@matthewfeickert
Copy link

This also breaks builds as there is now no longer a _build/html/lite directory.

for c in (
"jupyter",
"lite",
"doit" "build",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Carreau I think you missed a comma here(?).

I don't have time now, but I will try to debug this more tonight US time.

@steppi
Copy link
Collaborator

steppi commented Mar 20, 2024

Many apologies everyone. It looks like I jumped the gun. @matthewfeickert, I’m away from my machine and on mobile, but can take a look at things too in a couple hours.

@matthewfeickert
Copy link

matthewfeickert commented Mar 20, 2024

Thanks @steppi. As jupyterlite-sphinx v0.13.0 contains bugs that are breaking builds can you please yank it from PyPI and update the release notes to reflect this?

jupyterlite_dir,
"--log-level" if jupyterlite_log_level is not None else None,
jupyterlite_log_level,
"--",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this -- is also an unintended addition. ?

Copy link

@matthewfeickert matthewfeickert Mar 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

c.f. PR #152

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's needed to pass the args to doit in jupyterlite build. See jupyterlite/jupyterlite#1351

@steppi
Copy link
Collaborator

steppi commented Mar 20, 2024

Thanks @steppi. As jupyterlite-sphinx v0.13.0 contains bugs that are breaking builds can you please yank it from PyPI and update the release notes to reflect this?

Yes. That's definitely needed. I think one of @martinRenou or @jtpio will need to yank it though.

@jtpio
Copy link
Member

jtpio commented Mar 20, 2024

Just yanked the 0.13.0 release:

image

FYI I added @Carreau to the project on PyPI. @steppi what is your handle on PyPI, so I can also add you there?

@Carreau
Copy link
Collaborator Author

Carreau commented Mar 20, 2024

Sorry I should have tested more. I mostly checked it was not failing at the end of yesterday. Thanks for caching that,.

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

Successfully merging this pull request may close these issues.

4 participants