8000 [3.10] gh-100583: Improve the `pydoc` documentation (GH-100590) by miss-islington · Pull Request #100607 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

[3.10] gh-100583: Improve the pydoc documentation (GH-100590) #100607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2022
Merged

[3.10] gh-100583: Improve the pydoc documentation (GH-100590) #100607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
8000
Diff view
gh-100583: Improve the pydoc documentation (GH-100590) 
(cherry picked from commit 7223d50)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
  • Loading branch information
@ramvikrams @miss-islington
ramvikrams authored and miss-islington committed Dec 29, 2022
commit 991e562c3740318bbd4933ca07d074671aa2c8bd
8 changes: 4 additions & 4 deletions Doc/library/pydoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
style similar to the manual pages shown by the Unix :program:`man` command. The
Expand Down Expand Up @@ -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.

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
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
: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
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
: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
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
Expand Down
0