Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Doc: Note that pydoc uses and prefers ``MANPAGER`` (#125362) 

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Matthieu Ancellin 2024-10-30 00:12:02 +01:00 committed by GitHub
parent 298e041631
commit 0e45b1fd0f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Doc/conf.py
View File

@ -199,6 +199,7 @@ nitpick_ignore = [
('envvar', 'LC_TIME'),
('envvar', 'LINES'),
('envvar', 'LOGNAME'),
('envvar', 'MANPAGER'),
('envvar', 'PAGER'),
('envvar', 'PATH'),
('envvar', 'PATHEXT'),

5
Doc/library/pydoc.rst
View File

@ -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