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

Sometimes _viewcode_modules can be False; don't crash when it is #8888

Merged
merged 1 commit into from Feb 15, 2021

Conversation

virtuald
Copy link
Contributor

Subject: Sometimes _viewcode_modules can be False; don't crash when it is

Not sure if this is a 'good' fix for the problem, but my documentation builds now. It appears that when ModuleAnalyzer.for_module(modname) fails at viewcode.py:90 then it sets the module to False, thus breaking when env_purge_doc is called.

Not sure what the ModuleAnalyzer does or why it failed, but I don't care? Would be great to get this out in a 3.5.1 release as soon as possible since this breaks existing documentation.

Feature or Bugfix

  • Bugfix

Purpose

Detail

Relates

@virtuald
Copy link
Contributor Author

virtuald commented Feb 15, 2021

I'm not really sure why the tests failed, but it doesn't seem related to this (though it may be?). I'm not familiar enough with the sphinx codebase to determine why and I don't really want to be familiar enough. :-D

@jfbu
Copy link
Contributor

jfbu commented Feb 15, 2021

Tests are failing due to Pygments 2.8.0 which was released yesterday too, it requires changes to our test suite (cf #8887).

@tk0miya
Copy link
Member

tk0miya commented Feb 15, 2021

Thank you for your contribution. Merged into 3.5.x branch now.

@virtuald virtuald deleted the fix-viewcode branch February 15, 2021 21:34
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extension error (sphinx.ext.viewcode) with Sphinx 3.5
3 participants