Skip to content

Commit 58aeff5

Browse files
QuLogicbrunobeltran
authored andcommitted
Fix doc build with Sphinx < 3.
The `:c:var:` role was only added in 3.0, but it's an alias of `:c:data`, so use that instead.
1 parent 882c077 commit 58aeff5

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

doc/users/interactive_guide.rst

+6-7
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ Eventloop integration mechanism
392392
CPython / readline
393393
------------------
394394

395-
The Python C API provides a hook, :c:var:`PyOS_InputHook`, to register a
395+
The Python C API provides a hook, :c:data:`PyOS_InputHook`, to register a
396396
function to be run "The function will be called when Python's
397397
interpreter prompt is about to become idle and wait for user input
398398
from the terminal.". This hook can be used to integrate a second
@@ -402,12 +402,11 @@ event queue, run the main loop for a short fixed amount of time, or
402402
run the event loop until a key is pressed on stdin.
403403

404404

405-
Matplotlib does not currently do any management of
406-
:c:var:`PyOS_InputHook` due to the wide range of ways that Matplotlib
407-
is used. This management is left to downstream libraries -- either
408-
user code or the shell. Interactive figures, even with matplotlib in
409-
'interactive mode', may not work in the vanilla python repl if an
410-
appropriate :c:var:`PyOS_InputHook` is not registered.
405+
Matplotlib does not currently do any management of :c:data:`PyOS_InputHook` due
406+
to the wide range of ways that Matplotlib is used. This management is left to
407+
downstream libraries -- either user code or the shell. Interactive figures,
408+
even with matplotlib in 'interactive mode', may not work in the vanilla python
409+
repl if an appropriate :c:data:`PyOS_InputHook` is not registered.
411410

412411
Input hooks, and helpers to install them, are usually included with
413412
the python bindings for GUI toolkits and may be registered on import.

0 commit comments

Comments
 (0)