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

gh-100583: Improve the `pydoc` documentation (#100590)

This commit is contained in:
ram vikram singh 2022-12-29 20:47:20 +05:30 committed by GitHub
parent 76856366d3
commit 7223d50b97
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/pydoc.rst
View File

@ -33,7 +33,7 @@ as text on the console. The same text documentation can also be viewed from
outside the Python interpreter by running :program:`pydoc` as a script at the outside the Python interpreter by running :program:`pydoc` as a script at the
operating system's command prompt. For example, running :: operating system's command prompt. For example, running ::
pydoc sys python -m pydoc sys
at a shell prompt will display documentation on the :mod:`sys` module, in a at a shell prompt will display documentation on the :mod:`sys` module, in a
style similar to the manual pages shown by the Unix :program:`man` command. The style similar to the manual pages shown by the Unix :program:`man` command. The
@ -65,18 +65,18 @@ manner similar to the Unix :program:`man` command. The synopsis line of a
module is the first line of its documentation string. module is the first line of its documentation string.
You can also use :program:`pydoc` to start an HTTP server on the local machine You can also use :program:`pydoc` to start an HTTP server on the local machine
that will serve documentation to visiting web browsers. :program:`pydoc -p 1234` that will serve documentation to visiting web browsers. :program:`python -m pydoc -p 1234`
will start a HTTP server on port 1234, allowing you to browse the will start a HTTP server on port 1234, allowing you to browse the
documentation at ``http://localhost:1234/`` in your preferred web browser. documentation at ``http://localhost:1234/`` in your preferred web browser.
Specifying ``0`` as the port number will select an arbitrary unused port. Specifying ``0`` as the port number will select an arbitrary unused port.
:program:`pydoc -n <hostname>` will start the server listening at the given :program:`python -m 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 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 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 server responds to. During development this is especially useful if you want
to run pydoc from within a container. to run pydoc from within a container.
:program:`pydoc -b` will start the server and additionally open a web :program:`python -m 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 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 top where you can *Get* help on an individual item, *Search* all modules with a
keyword in their synopsis line, and go to the *Module index*, *Topics* and keyword in their synopsis line, and go to the *Module index*, *Topics* and