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

fix: Use Path object for jupyterlite-sphinx jupyterlite_dir config #2300

Merged
merged 1 commit into from
Aug 17, 2023

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Aug 17, 2023

Description

Resolves #2299

To avoid warning

WARNING: The config value `jupyterlite_dir' has type `str', defaults to `PosixPath'.

use a pathlib.Path for the jupyterlite-sphinx v0.9.1 jupyterlite_dir config option.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* To avoid warning

WARNING: The config value `jupyterlite_dir' has type `str', defaults to `PosixPath'.

 use a pathlib.Path for the jupyterlite-sphinx v0.9.1 jupyterlite_dir config
 option.

* To avoid warning

```
WARNING: The config value `jupyterlite_dir' has type `str', defaults to `PosixPath'.
```

  use a pathlib.Path for the jupyterlite-sphinx jupyterlite_dir config
  option.
@matthewfeickert matthewfeickert added docs Documentation related fix A bug fix need-to-backport tmp label until can be backported to patch release branch labels Aug 17, 2023
@matthewfeickert matthewfeickert self-assigned this Aug 17, 2023
@matthewfeickert
Copy link
Member Author

I'm going to approve and merge this myself in the interest of finishing out Issue #2289. As always, PRs approved by a single core dev can be reverted as needed by the rest of the dev team.

@codecov
Copy link

codecov bot commented Aug 17, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (b687487) 98.30% compared to head (b685f3e) 98.30%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2300   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          69       69           
  Lines        4536     4536           
  Branches      802      802           
=======================================
  Hits         4459     4459           
  Misses         45       45           
  Partials       32       32           
Flag Coverage Δ
contrib 97.88% <ø> (ø)
doctest 61.04% <ø> (ø)
unittests-3.10 96.31% <ø> (ø)
unittests-3.11 96.31% <ø> (ø)
unittests-3.8 96.34% <ø> (ø)
unittests-3.9 96.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@matthewfeickert matthewfeickert merged commit e48c035 into main Aug 17, 2023
20 checks passed
@matthewfeickert matthewfeickert deleted the docs/fix-jupyterlite-warning branch August 17, 2023 21:27
@matthewfeickert matthewfeickert mentioned this pull request Aug 17, 2023
41 tasks
@matthewfeickert matthewfeickert removed the need-to-backport tmp label until can be backported to patch release branch label Sep 6, 2023
matthewfeickert added a commit that referenced this pull request Sep 6, 2023
matthewfeickert added a commit that referenced this pull request Mar 22, 2024
)

* To avoid warning

WARNING: The config value `jupyterlite_dir` has type `PosixPath`, defaults to `str`.

 use a str for the jupyterlite-sphinx v0.13.0+ jupyterlite_dir config
 option.
* Update jupyterlite-sphinx lower bound to v0.13.1 in 'docs' extra.
* Amends PR #2300
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fix A bug fix
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Sphinx warning in docs for config value jupyterlite_dir has type str, defaults to PosixPath
1 participant