summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2014-11-26 12:46:06 -0500
committerTim Graham <timograham@gmail.com>2014-11-26 12:46:06 -0500
commit379431ef91023f47797a29bb0931685033c24827 (patch)
tree96839b5082b52f42bbe8208d4b25ab5882ea3425 /docs
parent14a3b60981f63334520c713bb3a2c9c694c49a1f (diff)
Updated GIS docs to use doc links.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/gis/admin.txt3
-rw-r--r--docs/ref/contrib/gis/commands.txt2
-rw-r--r--docs/ref/contrib/gis/db-api.txt6
-rw-r--r--docs/ref/contrib/gis/forms-api.txt2
-rw-r--r--docs/ref/contrib/gis/gdal.txt2
-rw-r--r--docs/ref/contrib/gis/geoip.txt2
-rw-r--r--docs/ref/contrib/gis/geoquerysets.txt5
-rw-r--r--docs/ref/contrib/gis/geos.txt2
-rw-r--r--docs/ref/contrib/gis/index.txt2
-rw-r--r--docs/ref/contrib/gis/install/geolibs.txt14
-rw-r--r--docs/ref/contrib/gis/install/index.txt5
-rw-r--r--docs/ref/contrib/gis/install/postgis.txt2
-rw-r--r--docs/ref/contrib/gis/install/spatialite.txt6
-rw-r--r--docs/ref/contrib/gis/layermapping.txt2
-rw-r--r--docs/ref/contrib/gis/measure.txt2
-rw-r--r--docs/ref/contrib/gis/model-api.txt2
-rw-r--r--docs/ref/contrib/gis/ogrinspect.txt2
-rw-r--r--docs/ref/contrib/gis/serializers.txt2
-rw-r--r--docs/ref/contrib/gis/tutorial.txt16
-rw-r--r--docs/ref/contrib/gis/utils.txt2
-rw-r--r--docs/releases/1.2.txt11
-rw-r--r--docs/releases/1.6.txt6
22 files changed, 28 insertions, 70 deletions
diff --git a/docs/ref/contrib/gis/admin.txt b/docs/ref/contrib/gis/admin.txt
index d3bc1d26a1..ef4a8ee526 100644
--- a/docs/ref/contrib/gis/admin.txt
+++ b/docs/ref/contrib/gis/admin.txt
@@ -1,5 +1,3 @@
-.. _ref-gis-admin:
-
======================
GeoDjango's admin site
======================
@@ -7,7 +5,6 @@ GeoDjango's admin site
.. module:: django.contrib.gis.admin
:synopsis: GeoDjango's extensions to the admin site.
-
``GeoModelAdmin``
=================
diff --git a/docs/ref/contrib/gis/commands.txt b/docs/ref/contrib/gis/commands.txt
index e1260e4e03..d22621aafe 100644
--- a/docs/ref/contrib/gis/commands.txt
+++ b/docs/ref/contrib/gis/commands.txt
@@ -1,5 +1,3 @@
-.. ref-geodjango-admin:
-
=============================
GeoDjango Management Commands
=============================
diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt
index 6958135f88..1597d7501c 100644
--- a/docs/ref/contrib/gis/db-api.txt
+++ b/docs/ref/contrib/gis/db-api.txt
@@ -1,5 +1,3 @@
-.. _ref-gis-db-api:
-
======================
GeoDjango Database API
======================
@@ -100,7 +98,7 @@ GeoDjango are only available on geometry fields.
Filters on 'normal' fields (e.g. :class:`~django.db.models.CharField`)
may be chained with those on geographic fields. Thus, geographic queries
take the following general form (assuming the ``Zipcode`` model used in the
-:ref:`ref-gis-model-api`)::
+:doc:`model-api`)::
>>> qs = Zipcode.objects.filter(<field>__<lookup_type>=<parameter>)
>>> qs = Zipcode.objects.exclude(...)
@@ -135,7 +133,7 @@ Distance calculations with spatial data is tricky because, unfortunately,
the Earth is not flat. Some distance queries with fields in a geographic
coordinate system may have to be expressed differently because of
limitations in PostGIS. Please see the :ref:`selecting-an-srid` section
-in the :ref:`ref-gis-model-api` documentation for more details.
+in the :doc:`model-api` documentation for more details.
.. _distance-lookups-intro:
diff --git a/docs/ref/contrib/gis/forms-api.txt b/docs/ref/contrib/gis/forms-api.txt
index 9ef33e03db..dfe004c6b2 100644
--- a/docs/ref/contrib/gis/forms-api.txt
+++ b/docs/ref/contrib/gis/forms-api.txt
@@ -1,5 +1,3 @@
-.. _ref-gis-forms-api:
-
===================
GeoDjango Forms API
===================
diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt
index 4c3d8a1945..ce3cdc79d5 100644
--- a/docs/ref/contrib/gis/gdal.txt
+++ b/docs/ref/contrib/gis/gdal.txt
@@ -1,5 +1,3 @@
-.. _ref-gdal:
-
========
GDAL API
========
diff --git a/docs/ref/contrib/gis/geoip.txt b/docs/ref/contrib/gis/geoip.txt
index ec83a45aab..424d124573 100644
--- a/docs/ref/contrib/gis/geoip.txt
+++ b/docs/ref/contrib/gis/geoip.txt
@@ -1,5 +1,3 @@
-.. _ref-geoip:
-
======================
Geolocation with GeoIP
======================
diff --git a/docs/ref/contrib/gis/geoquerysets.txt b/docs/ref/contrib/gis/geoquerysets.txt
index b8aeaf6157..48a45310e2 100644
--- a/docs/ref/contrib/gis/geoquerysets.txt
+++ b/docs/ref/contrib/gis/geoquerysets.txt
@@ -1,5 +1,3 @@
-.. _ref-geoquerysets:
-
=========================
GeoQuerySet API Reference
=========================
@@ -8,7 +6,6 @@ GeoQuerySet API Reference
.. class:: GeoQuerySet([model=None])
-
.. _spatial-lookups:
Spatial Lookups
@@ -730,7 +727,7 @@ the distance from the `Tasmanian`__ city of Hobart to every other
:class:`~django.contrib.gis.measure.Distance` object, you can easily express
the value in the units of your choice. For example, ``city.distance.mi`` is
the distance value in miles and ``city.distance.km`` is the distance value
- in kilometers. See the :ref:`ref-measure` for usage details and the list of
+ in kilometers. See :doc:`measure` for usage details and the list of
:ref:`supported_units`.
__ https://github.com/django/django/blob/master/django/contrib/gis/tests/distapp/models.py
diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt
index 3103768b1b..28606cd615 100644
--- a/docs/ref/contrib/gis/geos.txt
+++ b/docs/ref/contrib/gis/geos.txt
@@ -1,5 +1,3 @@
-.. _ref-geos:
-
========
GEOS API
========
diff --git a/docs/ref/contrib/gis/index.txt b/docs/ref/contrib/gis/index.txt
index c533aa459d..538cc3fb2d 100644
--- a/docs/ref/contrib/gis/index.txt
+++ b/docs/ref/contrib/gis/index.txt
@@ -1,5 +1,3 @@
-.. _ref-contrib-gis:
-
=========
GeoDjango
=========
diff --git a/docs/ref/contrib/gis/install/geolibs.txt b/docs/ref/contrib/gis/install/geolibs.txt
index bfd9af6528..48f134c670 100644
--- a/docs/ref/contrib/gis/install/geolibs.txt
+++ b/docs/ref/contrib/gis/install/geolibs.txt
@@ -1,5 +1,3 @@
-.. _geospatial_libs:
-
===============================
Installing Geospatial libraries
===============================
@@ -10,10 +8,10 @@ geospatial libraries:
======================== ==================================== ================================ ==========================
Program Description Required Supported Versions
======================== ==================================== ================================ ==========================
-:ref:`GEOS <ref-geos>` Geometry Engine Open Source Yes 3.4, 3.3, 3.2
+:doc:`GEOS <../geos>` Geometry Engine Open Source Yes 3.4, 3.3, 3.2
`PROJ.4`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 4.8, 4.7, 4.6, 4.5, 4.4
-:ref:`GDAL <ref-gdal>` Geospatial Data Abstraction Library Yes (SQLite only) 1.10, 1.9, 1.8, 1.7
-:ref:`GeoIP <ref-geoip>` IP-based geolocation library No 1.4
+:doc:`GDAL <../gdal>` Geospatial Data Abstraction Library Yes (SQLite only) 1.10, 1.9, 1.8, 1.7
+:doc:`GeoIP <../geoip>` IP-based geolocation library No 1.4
`PostGIS`__ Spatial extensions for PostgreSQL Yes (PostgreSQL only) 2.1, 2.0, 1.5
`SpatiaLite`__ Spatial extensions for SQLite Yes (SQLite only) 4.1, 4.0, 3.0, 2.4
======================== ==================================== ================================ ==========================
@@ -42,7 +40,7 @@ totally fine with GeoDjango. Your mileage may vary.
.. admonition:: Install GDAL
While :ref:`gdalbuild` is technically not required, it is *recommended*.
- Important features of GeoDjango (including the :ref:`ref-layermapping`,
+ Important features of GeoDjango (including the :doc:`../layermapping`,
geometry reprojection, and the geographic admin) depend on its
functionality.
@@ -66,7 +64,7 @@ install, directly or by dependency, the required geospatial libraries:
Optional packages to consider:
-* ``libgeoip1``: for :ref:`GeoIP <ref-geoip>` support
+* ``libgeoip1``: for :doc:`GeoIP <../geoip>` support
* ``gdal-bin``: for GDAL command line programs like ``ogr2ogr``
* ``python-gdal`` for GDAL's own Python bindings -- includes interfaces for raster manipulation
@@ -195,7 +193,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 :ref:`GDAL's vector data <ref-gdal>` capabilities [#]_.
+supports :doc:`GDAL's vector data <../gdal>` 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 935f311232..6e326f0455 100644
--- a/docs/ref/contrib/gis/install/index.txt
+++ b/docs/ref/contrib/gis/install/index.txt
@@ -1,5 +1,3 @@
-.. _ref-gis-install:
-
======================
GeoDjango Installation
======================
@@ -12,7 +10,7 @@ In general, GeoDjango installation requires:
1. :ref:`Python and Django <django>`
2. :ref:`spatial_database`
-3. :ref:`geospatial_libs`
+3. :doc:`geolibs`
Details for each of the requirements and installation instructions
are provided in the sections below. In addition, platform-specific
@@ -41,7 +39,6 @@ Because GeoDjango is included with Django, please refer to Django's
:ref:`installation instructions <installing-official-release>` for details on
how to install.
-
.. _spatial_database:
Spatial database
diff --git a/docs/ref/contrib/gis/install/postgis.txt b/docs/ref/contrib/gis/install/postgis.txt
index 79963bc981..e9c611aa31 100644
--- a/docs/ref/contrib/gis/install/postgis.txt
+++ b/docs/ref/contrib/gis/install/postgis.txt
@@ -1,5 +1,3 @@
-.. _postgis:
-
==================
Installing PostGIS
==================
diff --git a/docs/ref/contrib/gis/install/spatialite.txt b/docs/ref/contrib/gis/install/spatialite.txt
index a68c5eace0..d5e04a3c8d 100644
--- a/docs/ref/contrib/gis/install/spatialite.txt
+++ b/docs/ref/contrib/gis/install/spatialite.txt
@@ -1,5 +1,3 @@
-.. _spatialite:
-
=====================
Installing Spatialite
=====================
@@ -24,8 +22,8 @@ __ http://www.gaia-gis.it/gaia-sins/
Installing from source
~~~~~~~~~~~~~~~~~~~~~~
-:ref:`GEOS and PROJ.4<geospatial_libs>` should be installed prior to building
-SpatiaLite.
+:doc:`GEOS and PROJ.4</ref/contrib/gis/install/geolibs>` should be installed
+prior to building SpatiaLite.
SQLite
^^^^^^
diff --git a/docs/ref/contrib/gis/layermapping.txt b/docs/ref/contrib/gis/layermapping.txt
index b8ae5dc7fa..14f93307f8 100644
--- a/docs/ref/contrib/gis/layermapping.txt
+++ b/docs/ref/contrib/gis/layermapping.txt
@@ -1,5 +1,3 @@
-.. _ref-layermapping:
-
====================================
``LayerMapping`` data import utility
====================================
diff --git a/docs/ref/contrib/gis/measure.txt b/docs/ref/contrib/gis/measure.txt
index c4f6fc6954..6572ce5c67 100644
--- a/docs/ref/contrib/gis/measure.txt
+++ b/docs/ref/contrib/gis/measure.txt
@@ -1,5 +1,3 @@
-.. _ref-measure:
-
===================
Measurement Objects
===================
diff --git a/docs/ref/contrib/gis/model-api.txt b/docs/ref/contrib/gis/model-api.txt
index 2c41b368e0..6dd4710e69 100644
--- a/docs/ref/contrib/gis/model-api.txt
+++ b/docs/ref/contrib/gis/model-api.txt
@@ -1,5 +1,3 @@
-.. _ref-gis-model-api:
-
===================
GeoDjango Model API
===================
diff --git a/docs/ref/contrib/gis/ogrinspect.txt b/docs/ref/contrib/gis/ogrinspect.txt
index ed285e0ef1..ffaf8f7e37 100644
--- a/docs/ref/contrib/gis/ogrinspect.txt
+++ b/docs/ref/contrib/gis/ogrinspect.txt
@@ -1,5 +1,3 @@
-.. _ref-ogrinspect:
-
==============
OGR Inspection
==============
diff --git a/docs/ref/contrib/gis/serializers.txt b/docs/ref/contrib/gis/serializers.txt
index 4e445f03ad..54b6c5727c 100644
--- a/docs/ref/contrib/gis/serializers.txt
+++ b/docs/ref/contrib/gis/serializers.txt
@@ -1,5 +1,3 @@
-.. _ref-geojson-serializer:
-
==================
GeoJSON Serializer
==================
diff --git a/docs/ref/contrib/gis/tutorial.txt b/docs/ref/contrib/gis/tutorial.txt
index a8c68f3b8e..fa14df5e8b 100644
--- a/docs/ref/contrib/gis/tutorial.txt
+++ b/docs/ref/contrib/gis/tutorial.txt
@@ -23,7 +23,7 @@ familiarize yourself with Django first.
.. note::
GeoDjango has additional requirements beyond what Django requires --
- please consult the :ref:`installation documentation <ref-gis-install>`
+ please consult the :doc:`installation documentation <install/index>`
for more details.
This tutorial will guide you through the creation of a geographic web
@@ -326,9 +326,9 @@ database:
Importing Spatial Data
======================
-This section will show you how to import the world borders
-shapefile into the database via GeoDjango models using the
-:ref:`ref-layermapping`.
+This section will show you how to import the world borders shapefile into the
+database via GeoDjango models using the :doc:`layermapping`.
+
There are many different ways to import data into a spatial database --
besides the tools included within GeoDjango, you may also use the following:
@@ -530,7 +530,7 @@ Next, import the ``load`` module, call the ``run`` routine, and watch
Try ``ogrinspect``
------------------
Now that you've seen how to define geographic models and import data with the
-:ref:`ref-layermapping`, it's possible to further automate this process with
+:doc:`layermapping`, it's possible to further automate this process with
use of the :djadmin:`ogrinspect` management command. The :djadmin:`ogrinspect`
command introspects a GDAL-supported vector data source (e.g., a shapefile)
and generates a model definition and ``LayerMapping`` dictionary automatically.
@@ -631,7 +631,7 @@ a ``contains`` lookup using the ``pnt_wkt`` as the parameter::
Here, you retrieved a ``GeoQuerySet`` with only one model: the border of
the United States (exactly what you would expect).
-Similarly, you may also use a :ref:`GEOS geometry object <ref-geos>`.
+Similarly, you may also use a :doc:`GEOS geometry object <geos>`.
Here, you can combine the ``intersects`` spatial lookup with the ``get``
method to retrieve only the ``WorldBorder`` instance for San Marino instead
of a queryset::
@@ -643,7 +643,7 @@ of a queryset::
<WorldBorder: San Marino>
The ``contains`` and ``intersects`` lookups are just a subset of the
-available queries -- the :ref:`ref-gis-db-api` documentation has more.
+available queries -- the :doc:`db-api` documentation has more.
Automatic Spatial Transformations
---------------------------------
@@ -787,7 +787,7 @@ available with the :class:`~django.contrib.gis.admin.GeoModelAdmin`
First, there are some important requirements:
* :class:`~django.contrib.gis.admin.OSMGeoAdmin` requires that
- :ref:`GDAL <ref-gdal>` is installed. If you are running GDAL 1.6 (uncommon)
+ :doc:`GDAL <gdal>` is installed. If you are running GDAL 1.6 (uncommon)
you will also need to add the :ref:`spherical mercator projection
<addgoogleprojection>` to the ``spatial_ref_sys`` table.
diff --git a/docs/ref/contrib/gis/utils.txt b/docs/ref/contrib/gis/utils.txt
index 539a4ca9a2..7110ddf43e 100644
--- a/docs/ref/contrib/gis/utils.txt
+++ b/docs/ref/contrib/gis/utils.txt
@@ -1,5 +1,3 @@
-.. _ref-gis-utils:
-
===================
GeoDjango Utilities
===================
diff --git a/docs/releases/1.2.txt b/docs/releases/1.2.txt
index 35ddde301a..c4380e79a9 100644
--- a/docs/releases/1.2.txt
+++ b/docs/releases/1.2.txt
@@ -370,13 +370,12 @@ methods are new in 1.2:
* :meth:`~django.contrib.gis.db.models.GeoQuerySet.reverse_geom`
* :meth:`~django.contrib.gis.db.models.GeoQuerySet.geohash`
-The :ref:`GEOS interface <ref-geos>` was updated to use
-thread-safe C library functions when available on the platform.
+The GEOS interface was updated to use thread-safe C library functions when
+available on the platform.
-The :ref:`GDAL interface <ref-gdal>` now allows the user to
-set a :attr:`~django.contrib.gis.gdal.Layer.spatial_filter` on
-the features returned when iterating over a
-:class:`~django.contrib.gis.gdal.Layer`.
+The GDAL interface now allows the user to set a
+:attr:`~django.contrib.gis.gdal.Layer.spatial_filter` on the features returned
+when iterating over a :class:`~django.contrib.gis.gdal.Layer`.
Finally, :doc:`GeoDjango's documentation </ref/contrib/gis/index>` is now
included with Django's and is no longer
diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt
index 7c4b1e57b0..2585de13b8 100644
--- a/docs/releases/1.6.txt
+++ b/docs/releases/1.6.txt
@@ -131,9 +131,9 @@ binary data in the database.
GeoDjango form widgets
~~~~~~~~~~~~~~~~~~~~~~
-GeoDjango now provides :ref:`form fields and widgets <ref-gis-forms-api>` for
-its geo-specialized fields. They are OpenLayers-based by default, but they can
-be customized to use any other JS framework.
+GeoDjango now provides :doc:`form fields and widgets </ref/contrib/gis/forms-api>`
+for its geo-specialized fields. They are OpenLayers-based by default, but they
+can be customized to use any other JS framework.
``check`` management command added for verifying compatibility
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~