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

Sphinx warning in docs for config value jupyterlite_dir has type str, defaults to PosixPath #2299

Closed
matthewfeickert opened this issue Aug 17, 2023 · 0 comments · Fixed by #2300
Assignees
Labels
bug Something isn't working docs Documentation related

Comments

@matthewfeickert
Copy link
Member

Following Issue #2297, the test build of the docs is failing with

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

This warning is treated as an error as we do this intentionally

pyhf/docs/Makefile

Lines 5 to 8 in b687487

# W: Turn warnings into errors
# n: Run in nit-picky mode
SPHINXOPTS = -W --keep-going #-n
SPHINXBUILD = sphinx-build

I'm not sure if this means that we need to update

pyhf/docs/conf.py

Lines 531 to 532 in b687487

# JupyterLite configuration
jupyterlite_dir = "lite"

to be a Pathlib Path or not. I'm not sure how that would work though.

@matthewfeickert matthewfeickert added bug Something isn't working docs Documentation related labels Aug 17, 2023
@matthewfeickert matthewfeickert changed the title Sphinx warning in docs for config value jupyterlite_dir' has type str', defaults to `PosixPath' Sphinx warning in docs for config value jupyterlite_dir has type str, defaults to PosixPath Aug 17, 2023
@matthewfeickert matthewfeickert self-assigned this Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant