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

Addressing Warning unpickable configuration value with Sphinx 7.3.7 Update #445

Closed
Revathyvenugopal162 opened this issue May 14, 2024 · 0 comments
Labels

Comments

@Revathyvenugopal162
Copy link

Issue Description:

With the recent update to Sphinx 7.3.7, the addition of

prepare_jinja_env(jinja_env) -> None: 
              jinja_env.globals["project_name"] = project 
autoapi_prepare_jinja_env = prepare_jinja_env 

is generating the warning: "WARNING: cannot cache unpickable configuration value: 'autoapi_prepare_jinja_env' (because it contains a function, class, or module object)."

To address this issue, users can add config.cache to suppress the warning in our conf.py. However, it would be beneficial to address this on your end, especially when autoapi_prepare_jinja_env is involved, rather than requiring users to add it individually to each conf.py file.

Steps to Reproduce:

  1. Update to Sphinx 7.3.7.
  2. Observe the warning message related to unpickable configuration value.

Linked Pull Request:

Pull Request #121

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

No branches or pull requests

2 participants