From c2e59785e0f54ff26fefa65d5205817b01cd078e Mon Sep 17 00:00:00 2001 From: kuyan Date: Mon, 14 Apr 2014 12:56:28 -0700 Subject: [PATCH 1/4] Update links to Python documentation. --- docs/intro/documentation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/intro/documentation.rst b/docs/intro/documentation.rst index cd22c95..8f3e170 100644 --- a/docs/intro/documentation.rst +++ b/docs/intro/documentation.rst @@ -6,8 +6,8 @@ Official Documentation The official Python Language and Library documentation can be found here: - - `Python 2.x `_ - - `Python 3.x `_ + - `Python 2.x `_ + - `Python 3.x `_ Read the Docs From f99e5c55514ec2c982cabbdd6f54de59f88d9fc3 Mon Sep 17 00:00:00 2001 From: kuyan Date: Mon, 14 Apr 2014 13:21:54 -0700 Subject: [PATCH 2/4] Expanded on Read the Docs section --- docs/intro/documentation.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/intro/documentation.rst b/docs/intro/documentation.rst index 8f3e170..ddd2e45 100644 --- a/docs/intro/documentation.rst +++ b/docs/intro/documentation.rst @@ -13,9 +13,10 @@ The official Python Language and Library documentation can be found here: Read the Docs ------------- -Read the Docs is a popular community project, providing a single location for -all documentation of popular and even more exotic Python modules. +Read the Docs is a popular community project that hosts documentation +for open source software. It holds documentation for many Python modules, +both popular and exotic. - `Read the Docs `_ + `Read the Docs `_ From 1bb07d41a5df2fd3cc5bb772c5f8b8961123f049 Mon Sep 17 00:00:00 2001 From: kuyan Date: Mon, 14 Apr 2014 13:23:29 -0700 Subject: [PATCH 3/4] Added pydoc section --- docs/intro/documentation.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/intro/documentation.rst b/docs/intro/documentation.rst index ddd2e45..bab0a9f 100644 --- a/docs/intro/documentation.rst +++ b/docs/intro/documentation.rst @@ -20,3 +20,21 @@ both popular and exotic. `Read the Docs `_ +pydoc +----- + +:program:`pydoc` is a utlity that is installed when you install Python. +It allows you to quickly retrieve and search for documentation from your +shell. For example, if you needed a quick refresher on the +:mod:`time` module, pulling up documentation would be as simple as + + .. code-block:: bash + + $ pydoc time + +The above command is essentially equivalent to opening the Python REPL +and running + + .. code-block:: python + + >>> help(time) From e7f23a931665f67d407a50b2aeed54a72852fec3 Mon Sep 17 00:00:00 2001 From: kuyan Date: Mon, 14 Apr 2014 13:28:59 -0700 Subject: [PATCH 4/4] Revised code-block types --- docs/intro/documentation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/intro/documentation.rst b/docs/intro/documentation.rst index bab0a9f..dd5053f 100644 --- a/docs/intro/documentation.rst +++ b/docs/intro/documentation.rst @@ -28,13 +28,13 @@ It allows you to quickly retrieve and search for documentation from your shell. For example, if you needed a quick refresher on the :mod:`time` module, pulling up documentation would be as simple as - .. code-block:: bash + .. code-block:: console $ pydoc time The above command is essentially equivalent to opening the Python REPL and running - .. code-block:: python + .. code-block:: pycon >>> help(time)