Skip to content

Fix signature of docutils include_source monkeypatch - #11610

Merged
AA-Turner merged 2 commits into
sphinx-doc:masterfrom
ksunden:docutils_monkeypatch
Aug 17, 2023
Merged

AA-Turner merged 2 commits into
sphinx-doc:masterfrom
ksunden:docutils_monkeypatch

Conversation

@ksunden

@ksunden ksunden commented Aug 17, 2023

Copy link
Copy Markdown
Contributor

The docutils insert_input method's second argument is called 'source', not 'path'

Feature or Bugfix

  • Bugfix

Purpose

The monkeypatching of docutils broke the matplotlib plot directive, which calls insert_input and passes the source parameter by name.
This PR simply matches the signature of the monkeypatch to that of the upstream method such that calling methods are not affected.

Relates

The docutils method's second argument is called 'source', not 'path'
@AA-Turner
AA-Turner merged commit b38d185 into sphinx-doc:master Aug 17, 2023
@AA-Turner

Copy link
Copy Markdown
Member

This will be in 7.2.2

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Sep 17, 2023
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.

2 participants