Skip to content

Files

Latest commit

4c94d43 · May 9, 2018

History

History
This branch is 1 commit ahead of, 6136 commits behind postgis/postgis:master.

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Sep 29, 2015
Mar 16, 2018
Jul 4, 2016
Sep 24, 2017
Oct 26, 2011
Feb 27, 2018
Jun 22, 2015
Jul 23, 2017
Mar 27, 2012
Feb 9, 2011
Sep 20, 2012
Sep 20, 2012
Oct 6, 2016
Oct 14, 2014
Aug 27, 2017
Jun 16, 2016
Nov 14, 2017
Sep 13, 2017
Sep 6, 2017
Sep 21, 2017
Feb 10, 2011
Apr 16, 2018
Feb 21, 2018
Jun 30, 2017
Apr 16, 2018
May 28, 2015
Mar 20, 2017
Apr 16, 2018
Apr 6, 2018
Jan 29, 2010
Jun 16, 2016
Mar 16, 2018
Oct 11, 2017
Dec 28, 2017
Apr 24, 2018
Sep 13, 2017
May 7, 2018
Apr 24, 2018
May 9, 2018
Jun 16, 2016
Jun 16, 2016
Jun 16, 2016
Jun 16, 2016
Dec 24, 2017
Feb 7, 2012
Jun 16, 2016
Jul 23, 2017
Jun 16, 2016
Oct 16, 2017
Jun 16, 2016
May 27, 2009
PostGIS Documentation
=====================

Overview
--------

PostGIS documentation is written in DocBook XML. The input file is
``postgis.xml``, which in turn includes all the individual chapter XML files.
From that file we can publish several formats, including HTML and PDF.

Make targets
------------

``make``
  same as ``make comments``

``make install``
  same as ``make comments-install``

``make uninstall``
  same as ``make comments-uninstall``

``make html``
  generates a single-file ``html/postgis.html``

``make chunked-html``
  generates a separate html file for every chapter or section break

``make pdf``
  generates a single PDF file with the PostGIS version as a filename

``make images``
  generates all the images used in the HTML and PDF targets

``make comments``
  generates an SQL script that add COMMENTs for every function (derived from
  the documentation)

``make doxygen``
  generates the developer's documentation using Doxygen

``make comments-install``
  copies the ``postgis-comments.sql`` script to the PostgreSQL ``contrib``
  directory

``make comments-uninstall``
  removes the ``postgis-comments.sql`` script from the ``contrib`` directory

``make clean``
  removes generated files except comments

``make maintainer-clean``
  removes all generated files (including comments)


Requirements
------------

To generate the html files and the comments:
 * xsltproc - http://xmlsoft.org/xslt/xsltproc2.html
 * DocBook XSL stylesheets
 * MathML 3 DTD - http://www.w3.org/Math/DTD/

To generate the images:
 * ImageMagick - http://www.imagemagick.org/

To generate a PDF:
 * dblatex - http://dblatex.sourceforge.net

To generate the developer's documentation:
 * Doxygen - http://www.stack.nl/~dimitri/doxygen/
 * Graphviz - http://www.graphviz.org/

How to
------

To generate images used in the documentation, follow these instructions on the
PostGIS wiki: http://trac.osgeo.org/postgis/wiki/DevWikiDocNewFeature

To run garden tests against functions, follow these instructions on the PostGIS
dev wiki: http://trac.osgeo.org/postgis/wiki/DevWikiGardenTest