From 2c4dc6476083c853b654e462c7ff65dbe0334c9e Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Sun, 16 Apr 2023 19:14:09 -0400 Subject: Used extlinks for PyPI links. Co-authored-by: Mariusz Felisiak --- docs/ref/contrib/gis/geoip2.txt | 3 +-- docs/ref/databases.txt | 22 +++++++--------------- docs/ref/django-admin.txt | 10 ++++------ docs/ref/utils.txt | 4 ++-- 4 files changed, 14 insertions(+), 25 deletions(-) (limited to 'docs/ref') diff --git a/docs/ref/contrib/gis/geoip2.txt b/docs/ref/contrib/gis/geoip2.txt index 414a4efe9c..6390c3de3a 100644 --- a/docs/ref/contrib/gis/geoip2.txt +++ b/docs/ref/contrib/gis/geoip2.txt @@ -9,7 +9,7 @@ The :class:`GeoIP2` object is a wrapper for the `MaxMind geoip2 Python library`__. [#]_ In order to perform IP-based geolocation, the :class:`GeoIP2` object requires -the `geoip2 Python library`__ and the GeoIP ``Country`` and/or ``City`` +the :pypi:`geoip2` Python package and the GeoIP ``Country`` and/or ``City`` datasets in binary format (the CSV files will not work!), downloaded from e.g. `MaxMind`__ or `DB-IP`__ websites. Grab the ``GeoLite2-Country.mmdb.gz`` and ``GeoLite2-City.mmdb.gz`` files and unzip them in a directory corresponding to @@ -19,7 +19,6 @@ Additionally, it is recommended to install the `libmaxminddb C library`__, so that ``geoip2`` can leverage the C library's faster speed. __ https://geoip2.readthedocs.io/ -__ https://pypi.org/project/geoip2/ __ https://dev.maxmind.com/geoip/geolite2-free-geolocation-data __ https://db-ip.com/db/lite.php __ https://github.com/maxmind/libmaxminddb/ diff --git a/docs/ref/databases.txt b/docs/ref/databases.txt index 928511d979..913853d0e7 100644 --- a/docs/ref/databases.txt +++ b/docs/ref/databases.txt @@ -448,12 +448,11 @@ MySQL DB API Drivers MySQL has a couple drivers that implement the Python Database API described in :pep:`249`: -- `mysqlclient`_ is a native driver. It's **the recommended choice**. +- :pypi:`mysqlclient` is a native driver. It's **the recommended choice**. - `MySQL Connector/Python`_ is a pure Python driver from Oracle that does not require the MySQL client library or any Python modules outside the standard library. -.. _mysqlclient: https://pypi.org/project/mysqlclient/ .. _MySQL Connector/Python: https://dev.mysql.com/downloads/connector/python/ These drivers are thread-safe and provide connection pooling. @@ -1176,21 +1175,14 @@ Using a 3rd-party database backend In addition to the officially supported databases, there are backends provided by 3rd parties that allow you to use other databases with Django: -* `CockroachDB`_ -* `Firebird`_ -* `Google Cloud Spanner`_ -* `Microsoft SQL Server`_ -* `TiDB`_ -* `YugabyteDB`_ +* :pypi:`CockroachDB ` +* :pypi:`Firebird ` +* :pypi:`Google Cloud Spanner ` +* :pypi:`Microsoft SQL Server ` +* :pypi:`TiDB ` +* :pypi:`YugabyteDB ` The Django versions and ORM features supported by these unofficial backends vary considerably. Queries regarding the specific capabilities of these unofficial backends, along with any support queries, should be directed to the support channels provided by each 3rd party project. - -.. _CockroachDB: https://pypi.org/project/django-cockroachdb/ -.. _Firebird: https://pypi.org/project/django-firebird/ -.. _Google Cloud Spanner: https://pypi.org/project/django-google-spanner/ -.. _Microsoft SQL Server: https://pypi.org/project/mssql-django/ -.. _TiDB: https://pypi.org/project/django-tidb/ -.. _YugabyteDB: https://pypi.org/project/django-yugabytedb/ diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt index 290d31f253..d268d88e80 100644 --- a/docs/ref/django-admin.txt +++ b/docs/ref/django-admin.txt @@ -881,7 +881,7 @@ needed. You don't need to restart the server for code changes to take effect. However, some actions like adding files don't trigger a restart, so you'll have to restart the server in these cases. -If you're using Linux or MacOS and install both `pywatchman`_ and the +If you're using Linux or MacOS and install both :pypi:`pywatchman` and the `Watchman`_ service, kernel signals will be used to autoreload the server (rather than polling file modification timestamps each second). This offers better performance on large projects, reduced response time after code changes, @@ -903,7 +903,6 @@ more robust change detection, and a reduction in power usage. Django supports by setting the :envvar:`DJANGO_WATCHMAN_TIMEOUT` environment variable. .. _Watchman: https://facebook.github.io/watchman/ -.. _pywatchman: https://pypi.org/project/pywatchman/ .. _watchman documentation: https://facebook.github.io/watchman/docs/config#ignore_dirs When you start the server, and each time you change Python code while the @@ -1920,9 +1919,9 @@ Under Windows, the legacy ``cmd.exe`` native console doesn't support ANSI escape sequences so by default there is no color output. In this case either of two third-party libraries are needed: -* Install colorama_, a Python package that translates ANSI color codes into - Windows API calls. Django commands will detect its presence and will make use - of its services to color output just like on Unix-based platforms. +* Install :pypi:`colorama`, a Python package that translates ANSI color codes + into Windows API calls. Django commands will detect its presence and will + make use of its services to color output just like on Unix-based platforms. ``colorama`` can be installed via pip: .. code-block:: doscon @@ -1941,7 +1940,6 @@ installation of ``ANSICON`` by setting the appropriate environmental variable, .. _`Windows Terminal`: https://www.microsoft.com/en-us/p/windows-terminal-preview/9n0dx20hk701 .. _`VS Code`: https://code.visualstudio.com .. _ANSICON: http://adoxa.altervista.org/ansicon/ -.. _colorama: https://pypi.org/project/colorama/ Custom colors ~~~~~~~~~~~~~ diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index c0d80406a1..792e7db920 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -698,8 +698,8 @@ escaping HTML. If ``value`` is ``"Joel a slug"`` the return value will be ``"Joel is a slug"``. - If you are looking for a more robust solution, take a look at the `bleach - `_ Python library. + If you are looking for a more robust solution, take a look at the + :pypi:`bleach` Python package. .. function:: html_safe() -- cgit v1.3