mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 03:01:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

bpo-31128: Allow pydoc to bind to arbitrary hostnames (#3011)

Browse source 
New -n flag allow overriding localhost with custom value,
for example to run from containers.
This commit is contained in:
Feanil Patel 2017-09-14 17:54:09 -04:00 • committed by Éric Araujo
parent ccb3c7654c
commit 6a396c9807
5 changed files with 39 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/pydoc.rst
View file

@ -70,6 +70,12 @@ will start a HTTP server on port 1234, allowing you to browse the
documentation at ``http://localhost:1234/`` in your preferred Web browser.
Specifying ``0`` as the port number will select an arbitrary unused port.
:program:`pydoc -n <hostname>` will start the server listening at the given
hostname. By default the hostname is 'localhost' but if you want the server to
be reached from other machines, you may want to change the host name that the
server responds to. During development this is especially useful if you want
to run pydoc from within a container.
:program:`pydoc -b` will start the server and additionally open a web
browser to a module index page. Each served page has a navigation bar at the
top where you can *Get* help on an individual item, *Search* all modules with a
@ -98,3 +104,6 @@ Reference Manual pages.
:mod:`pydoc` now uses :func:`inspect.signature` rather than
:func:`inspect.getfullargspec` to extract signature information from
callables.
.. versionchanged:: 3.7
Added the ``-n`` option.