diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/contributing/bugs-and-features.txt | 2 | ||||
| -rw-r--r-- | docs/internals/contributing/localizing.txt | 4 | ||||
| -rw-r--r-- | docs/internals/contributing/new-contributors.txt | 2 | ||||
| -rw-r--r-- | docs/internals/contributing/triaging-tickets.txt | 8 | ||||
| -rw-r--r-- | docs/internals/contributing/writing-code/working-with-git.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/gdal.txt | 10 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/geoip2.txt | 5 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/geos.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/install/geolibs.txt | 27 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/install/index.txt | 2 |
10 files changed, 41 insertions, 23 deletions
diff --git a/docs/internals/contributing/bugs-and-features.txt b/docs/internals/contributing/bugs-and-features.txt index d117b2e165..146603e226 100644 --- a/docs/internals/contributing/bugs-and-features.txt +++ b/docs/internals/contributing/bugs-and-features.txt @@ -55,7 +55,7 @@ particular: as they are filed. To understand the lifecycle of your ticket once you have created it, refer to -:doc:`triaging-tickets`. +:ref:`triage-workflow`. Reporting user interface bugs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/internals/contributing/localizing.txt b/docs/internals/contributing/localizing.txt index 112a74dd9e..59a60a6a4c 100644 --- a/docs/internals/contributing/localizing.txt +++ b/docs/internals/contributing/localizing.txt @@ -61,8 +61,8 @@ the date, time and numbers formatting particularities of your locale. See The format files aren't managed by the use of Transifex. To change them, you must: -* :doc:`Create a pull request<writing-code/submitting-patches>` against the - Django Git ``main`` branch, as for any code change. +* :ref:`Create a pull request <patch-review-checklist>` against the Django Git + ``main`` branch, as for any code change. * Open a ticket in Django's ticket system, set its ``Component`` field to ``Translations``, set the "has patch" flag, and include the link to the pull diff --git a/docs/internals/contributing/new-contributors.txt b/docs/internals/contributing/new-contributors.txt index 3ec74b6bd4..a6bb17ceeb 100644 --- a/docs/internals/contributing/new-contributors.txt +++ b/docs/internals/contributing/new-contributors.txt @@ -47,7 +47,7 @@ Keep old patches up-to-date Oftentimes the codebase will change between a patch being submitted and the time it gets reviewed. Make sure it still applies cleanly and functions as expected. Updating a patch is both useful and important! See more on -:doc:`writing-code/submitting-patches`. +:ref:`patch-review-checklist`. Write some documentation ------------------------ diff --git a/docs/internals/contributing/triaging-tickets.txt b/docs/internals/contributing/triaging-tickets.txt index c54065ea22..295bf25ee5 100644 --- a/docs/internals/contributing/triaging-tickets.txt +++ b/docs/internals/contributing/triaging-tickets.txt @@ -29,11 +29,13 @@ confusion or disagreement. Django is a community project, and every contribution helps. We can't do this without **you**! +.. _triage-workflow: + Triage workflow =============== Unfortunately, not all reports in the ticket tracker provide all the -:doc:`required details<bugs-and-features>`. A number of tickets have proposed +:ref:`required details <reporting-bugs>`. A number of tickets have proposed solutions, but those don't necessarily meet all the requirements :ref:`adhering to the guidelines for contributing <patch-style>`. @@ -168,8 +170,8 @@ Has patch --------- This means the ticket has an associated solution. These will be reviewed to -ensure they adhere to the :doc:`documented guidelines -<writing-code/submitting-patches>`. +ensure they adhere to the :ref:`documented guidelines +<patch-review-checklist>`. The following three fields (Needs documentation, Needs tests, Patch needs improvement) apply only if a patch has been supplied. diff --git a/docs/internals/contributing/writing-code/working-with-git.txt b/docs/internals/contributing/writing-code/working-with-git.txt index 579543f876..7209bc0624 100644 --- a/docs/internals/contributing/writing-code/working-with-git.txt +++ b/docs/internals/contributing/writing-code/working-with-git.txt @@ -4,7 +4,7 @@ Working with Git and GitHub This section explains how the community can contribute code to Django via pull requests. If you're interested in how :ref:`mergers <mergers-team>` handle -them, see :doc:`../committing-code`. +them, see :ref:`handling-pull-requests`. Below, we are going to show how to create a GitHub pull request containing the changes for Trac ticket #xxxxx. By creating a fully-ready pull request, you diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt index 51511717b1..f0bb719ca0 100644 --- a/docs/ref/contrib/gis/gdal.txt +++ b/docs/ref/contrib/gis/gdal.txt @@ -5,6 +5,11 @@ GDAL API .. module:: django.contrib.gis.gdal :synopsis: GeoDjango's high-level interface to the GDAL library. +.. _gdal-overview: + +Overview +======== + `GDAL`__ stands for **Geospatial Data Abstraction Library**, and is a veritable "Swiss army knife" of GIS data functionality. A subset of GDAL is the `OGR`__ Simple Features Library, which specializes @@ -24,9 +29,6 @@ to raster (image) data. __ https://gdal.org/ __ https://gdal.org/user/vector_data_model.html -Overview -======== - .. _gdal_sample_data: Sample Data @@ -43,6 +45,8 @@ data sets that you can use for testing. You can download them here: $ wget https://raw.githubusercontent.com/django/django/main/tests/gis_tests/data/cities/cities.{shp,prj,shx,dbf} $ wget https://raw.githubusercontent.com/django/django/main/tests/gis_tests/data/rasters/raster.tif +.. _gdal_vector_data: + Vector Data Source Objects ========================== diff --git a/docs/ref/contrib/gis/geoip2.txt b/docs/ref/contrib/gis/geoip2.txt index 70f8120fc5..86a8954daa 100644 --- a/docs/ref/contrib/gis/geoip2.txt +++ b/docs/ref/contrib/gis/geoip2.txt @@ -5,6 +5,11 @@ Geolocation with GeoIP2 .. module:: django.contrib.gis.geoip2 :synopsis: Python interface for MaxMind's GeoIP2 databases. +.. _geoip2-overview: + +Overview +======== + The :class:`GeoIP2` object is a wrapper for the :pypi:`MaxMind geoip2 Python library <geoip2>`. [#]_ diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index d46ce8f41a..85601a8685 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -5,6 +5,8 @@ GEOS API .. module:: django.contrib.gis.geos :synopsis: GeoDjango's high-level interface to the GEOS library. +.. _geos-overview: + Background ========== diff --git a/docs/ref/contrib/gis/install/geolibs.txt b/docs/ref/contrib/gis/install/geolibs.txt index 2794a42834..f6dba16906 100644 --- a/docs/ref/contrib/gis/install/geolibs.txt +++ b/docs/ref/contrib/gis/install/geolibs.txt @@ -2,19 +2,24 @@ Installing Geospatial libraries =============================== +.. _geolibs-list: + +Geospatial libraries +==================== + GeoDjango uses and/or provides interfaces for the following open source geospatial libraries: -======================== ==================================== ================================ ======================================================= -Program Description Required Supported Versions -======================== ==================================== ================================ ======================================================= -:doc:`GEOS <../geos>` Geometry Engine Open Source Yes 3.14, 3.13, 3.12, 3.11, 3.10, 3.9, 3.8 -`PROJ`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 9.x, 8.x, 7.x, 6.x -:doc:`GDAL <../gdal>` Geospatial Data Abstraction Library Yes 3.11, 3.10, 3.9, 3.8, 3.7, 3.6, 3.5, 3.4, 3.3, 3.2, 3.1 -:doc:`GeoIP <../geoip2>` IP-based geolocation library No 2 -`PostGIS`__ Spatial extensions for PostgreSQL Yes (PostgreSQL only) 3.5, 3.4, 3.3, 3.2, 3.1 -`SpatiaLite`__ Spatial extensions for SQLite Yes (SQLite only) 5.1, 5.0, 4.3 -======================== ==================================== ================================ ======================================================= +============================== ==================================== ================================ ======================================================= +Program Description Required Supported Versions +============================== ==================================== ================================ ======================================================= +:ref:`GEOS <geos-overview>` Geometry Engine Open Source Yes 3.14, 3.13, 3.12, 3.11, 3.10, 3.9, 3.8 +`PROJ`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 9.x, 8.x, 7.x, 6.x +:ref:`GDAL <gdal-overview>` Geospatial Data Abstraction Library Yes 3.11, 3.10, 3.9, 3.8, 3.7, 3.6, 3.5, 3.4, 3.3, 3.2, 3.1 +:ref:`GeoIP <geoip2-overview>` IP-based geolocation library No 2 +`PostGIS`__ Spatial extensions for PostgreSQL Yes (PostgreSQL only) 3.5, 3.4, 3.3, 3.2, 3.1 +`SpatiaLite`__ Spatial extensions for SQLite Yes (SQLite only) 5.1, 5.0, 4.3 +============================== ==================================== ================================ ======================================================= Note that older or more recent versions of these libraries *may* also work totally fine with GeoDjango. Your mileage may vary. @@ -235,7 +240,7 @@ GDAL `GDAL`__ is an excellent open source geospatial library that has support for reading most vector and raster spatial data formats. Currently, GeoDjango only -supports :doc:`GDAL's vector data <../gdal>` capabilities [#]_. +supports :ref:`GDAL's vector data <gdal_vector_data>` capabilities [#]_. :ref:`geosbuild` and :ref:`proj4` should be installed prior to building GDAL. First download the latest GDAL release version and untar the archive: diff --git a/docs/ref/contrib/gis/install/index.txt b/docs/ref/contrib/gis/install/index.txt index 93e0d8f149..9421723eb8 100644 --- a/docs/ref/contrib/gis/install/index.txt +++ b/docs/ref/contrib/gis/install/index.txt @@ -8,7 +8,7 @@ In general, GeoDjango installation requires: #. :ref:`Python and Django <django>` #. :ref:`spatial_database` -#. :doc:`geolibs` +#. :ref:`geolibs-list` Details for each of the requirements and installation instructions are provided in the sections below. In addition, platform-specific |