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

Support for Sphinx v5.1.0 #692

Closed
jdknight opened this issue Jul 24, 2022 · 3 comments
Closed

Support for Sphinx v5.1.0 #692

jdknight opened this issue Jul 24, 2022 · 3 comments
Milestone

Comments

@jdknight
Copy link
Member

jdknight commented Jul 24, 2022

As of Sphinx v5.1.0, this extension may fail to load for a user's environment with the following error:

Running Sphinx v5.1.0

Exception occurred:
  File ".\sphinx\registry.py", line 169, in create_builder
    builder = self.builders[name](app, env=...)  # type: ignore[arg-type]
TypeError: __init__() got an unexpected keyword argument 'env'

Users who are blocked by this may workaround this by performing one the following solutions until a new release has been made to PyPI:

  1. (recommended) Update to the most recent version v5.1.1 (or newer).
pip install -U sphinx
  1. Install the most recent development version of this extension:
pip install git+https://github.com/sphinx-contrib/confluencebuilder.git
  1. Downgrade Sphinx to v5.0.2 by using the following command:
pip install sphinx==5.0.2

See also:

@jdknight jdknight pinned this issue Jul 24, 2022
@jdknight jdknight added this to the 1.9 milestone Jul 24, 2022
@jdknight jdknight added the available-next-release Merged into the main branch but waiting for PyPI release label Jul 24, 2022
@ilCatania
Copy link

Thank you, I ran into this and pinning sphinx<5.1.0 as a workaround fixed it for me

@jdknight
Copy link
Member Author

Note that Sphinx v5.1.1 has been released, which should address the issues observed when loading the most recent stable version of this extension (v1.8).

I will leave this issue open for a small window of time for reference (if users are still transitioning between versions).

@jdknight jdknight unpinned this issue Aug 21, 2022
@jdknight
Copy link
Member Author

With v1.9 is now available on PyPI, there should be no longer an issue for users who may opt explicitly for a v.5.1.0 release. Marking as closed.

@jdknight jdknight removed the available-next-release Merged into the main branch but waiting for PyPI release label Aug 21, 2022
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

2 participants