#23803 closed defect (fixed)
Allow graceful Sphinx upgrades
Reported by: | jdemeyer | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | sage-8.1 |
Component: | packages: standard | Keywords: | |
Cc: | jhpalmieri | Merged in: | |
Authors: | Jeroen Demeyer | Reviewers: | John Palmieri |
Report Upstream: | Fixed upstream, but not in a stable release. | Work issues: | |
Branch: | 150baf5 (Commits, GitHub, GitLab) | Commit: | |
Dependencies: | Stopgaps: |
Description (last modified by )
The upgrade to Sphinx-1.6.3 broke docbuilding if make doc-clean
was not done. This is because the "environment pickle" from the old Sphinx failed to unpickle with the new Sphinx. This pickle is not so important, we can just ignore this error and continue.
Change History (10)
comment:1 Changed 5 years ago by
comment:3 Changed 5 years ago by
- Component changed from build to packages: standard
- Description modified (diff)
- Summary changed from Rebuild doc when Sphinx is reinstalled to Allow graceful Sphinx upgrades
comment:4 Changed 5 years ago by
- Branch set to u/jdemeyer/rebuild_doc_when_sphinx_is_reinstalled
comment:5 Changed 5 years ago by
- Commit set to 150baf55e4380b63b57fe998877cd5ce70a40bdb
- Status changed from new to needs_review
New commits:
150baf5 | Allow graceful Sphinx upgrade
|
comment:6 Changed 5 years ago by
Is it worth printing more information than just
[diophanti] loading pickled environment... failed: 'module' object has no attribute 'WarningStream'
to let users know that this is indeed harmless?
comment:7 follow-up: ↓ 8 Changed 5 years ago by
I don't really see the point... In any case, I feel that this is something that upstream should decide.
comment:8 in reply to: ↑ 7 Changed 5 years ago by
- Reviewers set to John Palmieri
- Status changed from needs_review to positive_review
Replying to jdemeyer:
I don't really see the point...
The point, as I said, is "to let users know that this is indeed harmless". Some people worry when they see messages saying that something "failed".
comment:9 Changed 5 years ago by
- Branch changed from u/jdemeyer/rebuild_doc_when_sphinx_is_reinstalled to 150baf55e4380b63b57fe998877cd5ce70a40bdb
- Resolution set to fixed
- Status changed from positive_review to closed
comment:10 Changed 5 years ago by
- Commit 150baf55e4380b63b57fe998877cd5ce70a40bdb deleted
- Report Upstream changed from N/A to Fixed upstream, but not in a stable release.
Actually, I'm experimenting with a much simpler change to allow a graceful upgrade to Sphinx-1.6.3: it's a specific pickle which fails to load. Wrapping that in
try
/except
might work.