I was having some trouble building docs locally due to some bad interaction between
the ipython sphinx directive and running in a virtual environment (despite ipython being installed in the environment)
Rather than spending a large amount of time figuring out how to resolve those incompatibilities, I just removed
the directive that was causing the problem and replaced it with code-block which is what we use everywhere else (that isn't a plot) anyway.
PR Checklist
Documentation and Tests
[N/A] Has pytest style unit tests (and pytest passes)
Documentation is sphinx and numpydoc compliant (the docs should build without error).
[N/A] New plotting related features are documented with examples.
Release Notes
[N/A] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
[N/A] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
[N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
PR Summary
I was having some trouble building docs locally due to some bad interaction between
the ipython sphinx directive and running in a virtual environment (despite ipython being installed in the environment)
Rather than spending a large amount of time figuring out how to resolve those incompatibilities, I just removed
the directive that was causing the problem and replaced it with code-block which is what we use everywhere else (that isn't a plot) anyway.
PR Checklist
Documentation and Tests
Release Notes