From 0e45b1fd0ffbb165f580ecdfd5234c1d54389501 Mon Sep 17 00:00:00 2001 From: Matthieu Ancellin <31126826+mancellin@users.noreply.github.com> Date: Wed, 30 Oct 2024 00:12:02 +0100 Subject: [PATCH] Doc: Note that pydoc uses and prefers ``MANPAGER`` (#125362) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- Doc/conf.py | 1 + Doc/library/pydoc.rst | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Doc/conf.py b/Doc/conf.py index 5e65d52f3c0..73d7d5db26f 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -199,6 +199,7 @@ nitpick_ignore = [ ('envvar', 'LC_TIME'), ('envvar', 'LINES'), ('envvar', 'LOGNAME'), + ('envvar', 'MANPAGER'), ('envvar', 'PAGER'), ('envvar', 'PATH'), ('envvar', 'PATHEXT'), diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index 70e9c604eba..e8f153ee1b3 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -52,8 +52,9 @@ produced for that file. only execute code when a file is invoked as a script and not just imported. When printing output to the console, :program:`pydoc` attempts to paginate the -output for easier reading. If the :envvar:`PAGER` environment variable is set, -:program:`pydoc` will use its value as a pagination program. +output for easier reading. If either the :envvar:`MANPAGER` or the +:envvar:`PAGER` environment variable is set, :program:`pydoc` will use its +value as a pagination program. When both are set, :envvar:`MANPAGER` is used. Specifying a ``-w`` flag before the argument will cause HTML documentation to be written out to a file in the current directory, instead of displaying text