GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix CI doctest, install-examples by roryyorke · Pull Request #1137 · python-control/python-control

Conversation

@roryyorke

@roryyorke roryyorke commented Mar 2, 2025

Copy link
Copy Markdown
Contributor

Fixes gh-1136.

I tried '!=8.2' for sphinx-doc, which didn't work, so I used '<8.2'. I think '!=8.2.*' might, but didn't try it. See https://packaging.python.org/en/latest/specifications/version-specifiers/#id5 (not sure this applies to Conda/Mamba - it should).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
roryyorke added 2 commits March 2, 2025 11:07
@roryyorke
Prevent IPython 9.0 being installed in CI
658e1c8
Workaround for ipython/ipython#14807
@roryyorke
Restrict sphinx version to < 8.2 in CI
2eab304
Workaround for sphinx-doc/sphinx#13352
@coveralls

coveralls commented Mar 2, 2025

Copy link
Copy Markdown

Coverage Status

coverage: 94.744%. remained the same
when pulling 2eab304 on roryyorke:fix-ci-doctest-install-examples
into f6799ab on python-control:main.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@murrayrm

murrayrm commented Mar 2, 2025

Copy link
Copy Markdown
Member

It would be nice to block out just the version that is failing, if possible, so that we will test against the latest new release when it comes out (and hopefully the bug is fixed).

Also, should we put something in pyproject.toml to flag this issue? If not, then a user could install with the latest version of iPython (or sphinx) and things might not work. I'm not quite sure where that would go, since python-control is not dependent on iPython.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@roryyorke

roryyorke commented Mar 2, 2025

Copy link
Copy Markdown
Contributor Author

For IPython, it's reasonably likely that an upcoming release, say 9.0.1, will fix this (ipython/ipython#14807 claims to fix it). If it's later, 9.0.2 or whatever, we can update the relevant config file(s) to exclude all the broken version. So here I think the CI fix is OK.

For sphinx, the situation is trickier. From sphinx-doc/sphinx#13364 and sphinx-doc/sphinx#13352 , sphinx have made a change that breaks nbsphinx, and nbsphinx has a PR for necessary updates at spatialaudio/nbsphinx#826, but it's not clear when that will be merged and released.

I don't think there's a way to say "use nbsphinx >= 0.9.7, or failing that, use sphinx < 8.2.*", so I think the sphinx version condition I've added is a stop-gap until there's a released nbsphinx fix. I know this sort of stop-gap can easily last months (or years), and I don't know what to do about that. I guess a TODO in the doctest-env.yml, and open an issue now.

I've pushed a prototype of sphinx!=8.2.*, see https://github.com/roryyorke/python-control/actions/runs/13617760094/job/38063032976 , but I now think it's just as much of a stop-gap as <8.2.

As for pyproject.toml: I don't know if we can or should do anything about IPython. It's a clear bug (install IPython, run load_ext autoreload, and it's triggered) that doesn't affect only control-python, and that should be fixed soon(ish). The same reasoning applies to sphinx and nbsphinx, but in addition I imagine non-dev users rarely install these.

murrayrm reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@murrayrm

murrayrm commented Mar 2, 2025

Copy link
Copy Markdown
Member

Thanks @roryyorke for the detail comments and the fix. I'll let this sit for a bit (at least rest of the day) before merging, in case others have comments. But I think this is otherwise good to go (and we need to get something in place soon to fix the CI tests for current and upcoming PRs).

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@lkies lkies mentioned this pull request Mar 2, 2025
Fix Latex not being rendered in HTML output in VSCode #1133
Merged
@murrayrm
murrayrm merged commit 58e7ad9 into python-control:main Mar 3, 2025
@murrayrm murrayrm added this to the 0.10.2 milestone Mar 3, 2025
@Carreau

Carreau commented Mar 3, 2025

Copy link
Copy Markdown

IPython 9.0.1 should be out.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.10.2

Development

Successfully merging this pull request may close these issues.

CI failures in doctest, examples

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@roryyorke @coveralls @murrayrm @Carreau
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.