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

autodoc_intenum tutorial: Return parallel_read_safe from setup() #12288

Merged
merged 3 commits into from
Apr 26, 2024

Conversation

mgeier
Copy link
Contributor

@mgeier mgeier commented Apr 15, 2024

TBH, I'm not actually sure if it is parallel-safe, someone should check that!

Feature or Bugfix

  • Bugfix

Purpose

Without returning parallel_read_safe, this extension inhibits parallel reading of source files, which sets a very bad example.

Relates

#12237

app.setup_extension('sphinx.ext.autodoc') # Require autodoc extension
app.add_autodocumenter(IntEnumDocumenter)
return {
'version': '0.1',
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
'version': '0.1',
'version': '1',

@AA-Turner AA-Turner merged commit 7649798 into sphinx-doc:master Apr 26, 2024
7 checks passed
@mgeier mgeier deleted the tutorial-autodoc-parallel branch April 26, 2024 12:36
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants