Skip to content

Documentation page additions #416

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
sigmavirus24 merged 4 commits into from Apr 14, 2014
Merged

Documentation page additions #416

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2e5978
Update links to Python documentation.
Apr 14, 2014
f99e5c5
Expanded on Read the Docs section
Apr 14, 2014
1bb07d4
Added pydoc section
Apr 14, 2014
e7f23a9
Revised code-block types
Apr 14, 2014
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
Diff view
29 changes: 24 additions & 5 deletions docs/intro/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,35 @@ Official Documentation

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

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


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 <http://readthedocs.org/>`_
`Read the Docs <https://readthedocs.org/>`_


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:: console

$ pydoc time

The above command is essentially equivalent to opening the Python REPL
and running

.. code-block:: pycon

>>> help(time)