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

Update development scripts/testing to include Sphinx v8.x #1023

Merged
merged 7 commits into from
Aug 5, 2024

Conversation

jdknight
Copy link
Member

@jdknight jdknight commented Aug 5, 2024

Updates the tox environment, GitHub actions and other tweaks to include Sphinx v8 series into this repository.

Configuring a minimum version of Sphinx to v7.1.x. We only support up to
five major-minor versions of Sphinx, and with Sphinx v8 released,
setting a new lowest version. This should prevent any issues from
arising for versions we no longer actively test on.

Signed-off-by: James Knight <james.d.knight@live.com>
Most recent work only aims to support v7.1+ series.

See CONTRIBUTING.md for additional information.

Signed-off-by: James Knight <james.d.knight@live.com>
Most recent work only aims to support v7.1+ series.

See CONTRIBUTING.md for additional information.

Signed-off-by: James Knight <james.d.knight@live.com>
Sphinx provides a stable v8.0.x series; adjusting the tox configuration
to support the new revision. Following maintenance guidelines, this
allows a series of legacy Sphinx revisions to be dropped as well.

See CONTRIBUTING.md for additional information.

Signed-off-by: James Knight <james.d.knight@live.com>
Avoid the need to duplicate a requirements include that could instead
be inherited from the base environment.

Signed-off-by: James Knight <james.d.knight@live.com>
Updating the check helper to use the most recent version of Sphinx.

Signed-off-by: James Knight <james.d.knight@live.com>
The tox configuration has been adjusted with a new version of Sphinx
versions to test against. Adjusting the automated building to invoke
these accordingly.

Signed-off-by: James Knight <james.d.knight@live.com>
@jdknight jdknight merged commit 2c6e30a into main Aug 5, 2024
27 checks passed
@jdknight jdknight deleted the devsync-for-sphinx-v8 branch August 5, 2024 17:53
@@ -19,7 +19,7 @@
supported_confluence_ver = '7.19+'
supported_python_ver = '3.8+'
supported_requests_ver = '2.25.0+'
supported_sphinx_ver = '6.1+'
supported_sphinx_ver = '7.1+'

Choose a reason for hiding this comment

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

@jdknight Hi, the pyproject.toml still requires Sphinx>=6.1, which can break installations, as sphinxcontrib-confluencebuilder is upgrade to 2.7 without bumping Sphinx to 7.1.

See the error below.

Sphinx version error:
The sphinxcontrib.confluencebuilder extension used by this project needs at least Sphinx v7.1; it therefore cannot be built with this version.

Copy link
Member Author

Choose a reason for hiding this comment

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

@robert-schmidtke, thanks for the report. Should be addressed in the v2.7.1 release.

Choose a reason for hiding this comment

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

Thanks for resolving this so quickly!

@jdknight jdknight added this to the 2.7.1 milestone Oct 12, 2024
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

Successfully merging this pull request may close these issues.

2 participants