Skip to content

Commit 313b432

Browse files
committed
Merge pull request realpython#416 from kuyan/master
Documentation page additions
2 parents cf3a875 + e7f23a9 commit 313b432

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

docs/intro/documentation.rst

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,35 @@ Official Documentation
66

77
The official Python Language and Library documentation can be found here:
88

9-
- `Python 2.x <http://docs.python.org/2.7/>`_
10-
- `Python 3.x <http://docs.python.org/py3k/>`_
9+
- `Python 2.x <https://docs.python.org/2/>`_
10+
- `Python 3.x <https://docs.python.org/3/>`_
1111

1212

1313
Read the Docs
1414
-------------
1515

16-
Read the Docs is a popular community project, providing a single location for
17-
all documentation of popular and even more exotic Python modules.
16+
Read the Docs is a popular community project that hosts documentation
17+
for open source software. It holds documentation for many Python modules,
18+
both popular and exotic.
1819

19-
`Read the Docs <http://readthedocs.org/>`_
20+
`Read the Docs <https://readthedocs.org/>`_
2021

2122

23+
pydoc
24+
-----
25+
26+
:program:`pydoc` is a utlity that is installed when you install Python.
27+
It allows you to quickly retrieve and search for documentation from your
28+
shell. For example, if you needed a quick refresher on the
29+
:mod:`time` module, pulling up documentation would be as simple as
30+
31+
.. code-block:: console
32+
33+
$ pydoc time
34+
35+
The above command is essentially equivalent to opening the Python REPL
36+
and running
37+
38+
.. code-block:: pycon
39+
40+
>>> help(time)

0 commit comments

Comments
 (0)