Skip to content

Commit

Permalink
Updated recommended Python resource to official Python Docs
Browse files Browse the repository at this point in the history
Revised Django documentation to highlight the official Python documentation as the primary resource for the language, replacing Dive into Python.
Outdated links for Dive into Python were also updated
Builds on PR django#17353
  • Loading branch information
TobeTek committed Jan 20, 2024
1 parent 718b32c commit 617e771
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 13 deletions.
2 changes: 1 addition & 1 deletion AUTHORS
Expand Up @@ -1084,6 +1084,6 @@ A big THANK YOU goes to:

Ian Bicking for convincing Adrian to ditch code generation.

Mark Pilgrim for "Dive Into Python" (https://www.diveinto.org/python3/).
Mark Pilgrim for "Dive Into Python" (https://diveintopython3.net/).

Guido van Rossum for creating Python.
5 changes: 2 additions & 3 deletions docs/intro/contributing.txt
Expand Up @@ -27,7 +27,7 @@ For this tutorial, we expect that you have at least a basic understanding of
how Django works. This means you should be comfortable going through the
existing tutorials on :doc:`writing your first Django app</intro/tutorial01>`.
In addition, you should have a good understanding of Python itself. But if you
don't, `Dive Into Python`__ is a fantastic (and free) online book for
don't, `Dive Into Python <https://diveintopython3.net/>`_ is a fantastic (and free) online book for
beginning Python programmers.

Those of you who are unfamiliar with version control systems and Trac will find
Expand All @@ -45,7 +45,6 @@ so that it can be of use to the widest audience.
`#django-dev on irc.libera.chat`__ to chat with other Django users who
might be able to help.

__ https://diveinto.org/python3/table-of-contents.html
__ https://web.libera.chat/#django-dev
.. _Django Forum: https://forum.djangoproject.com/

Expand Down Expand Up @@ -350,7 +349,7 @@ This test checks that the ``make_toast()`` returns ``'toast'``.
* After reading those, if you want something a little meatier to sink
your teeth into, there's always the Python :mod:`unittest` documentation.

__ https://diveinto.org/python3/unit-testing.html
__ https://diveintopython3.net/unit-testing.html

Running your new test
---------------------
Expand Down
7 changes: 4 additions & 3 deletions docs/intro/index.txt
Expand Up @@ -32,10 +32,11 @@ place: read this material to quickly get up and running.
`list of Python resources for non-programmers`_

If you already know a few other languages and want to get up to speed with
Python quickly, we recommend `Dive Into Python`_. If that's not quite your
style, there are many other `books about Python`_.
Python quickly, we recommend the official `Python documentation`_,
which provides comprehensive and authoritative information about the language,
as well as links to other resources such as a list of `books about Python`_.

.. _python: https://www.python.org/
.. _list of Python resources for non-programmers: https://wiki.python.org/moin/BeginnersGuide/NonProgrammers
.. _Dive Into Python: https://diveinto.org/python3/table-of-contents.html
.. _Python documentation: https://docs.python.org/3/
.. _books about Python: https://wiki.python.org/moin/PythonBooks
4 changes: 1 addition & 3 deletions docs/ref/django-admin.txt
Expand Up @@ -1797,7 +1797,7 @@ allows for the following options by default:

.. django-admin-option:: --pythonpath PYTHONPATH

Adds the given filesystem path to the Python `import search path`_. If this
Adds the given filesystem path to the Python :py:data:`sys.path` module attribute. If this
isn't provided, ``django-admin`` will use the :envvar:`PYTHONPATH` environment
variable.

Expand All @@ -1810,8 +1810,6 @@ Example usage:

django-admin migrate --pythonpath='/home/djangoprojects/myproject'

.. _import search path: https://diveinto.org/python3/your-first-python-program.html#importsearchpath

.. django-admin-option:: --settings SETTINGS

Specifies the settings module to use. The settings module should be in Python
Expand Down
2 changes: 1 addition & 1 deletion docs/ref/templates/builtins.txt
Expand Up @@ -2414,7 +2414,7 @@ individual elements of the sequence.
Returns a slice of the list.

Uses the same syntax as Python's list slicing. See
https://diveinto.org/python3/native-datatypes.html#slicinglists for an
https://docs.python.org/3/tutorial/introduction.html#lists for an
introduction.

Example:
Expand Down
3 changes: 1 addition & 2 deletions docs/topics/settings.txt
Expand Up @@ -44,9 +44,8 @@ by using an environment variable, :envvar:`DJANGO_SETTINGS_MODULE`.

The value of :envvar:`DJANGO_SETTINGS_MODULE` should be in Python path syntax,
e.g. ``mysite.settings``. Note that the settings module should be on the
Python `import search path`_.
Python :py:data:`sys.path`.

.. _import search path: https://diveinto.org/python3/your-first-python-program.html#importsearchpath

The ``django-admin`` utility
----------------------------
Expand Down

0 comments on commit 617e771

Please sign in to comment.