source: trunk/doc/README

Last change on this file was 9552, checked in by strk, 5 years ago

Update doc/README (#1721)

  • reStructuredText Markup, 80 column text limit
  • Structure the make targets using definition lists
  • It turns out that graphviz is required for make doxygen

Patch by Mike Toews

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.0 KB
Line 
1PostGIS Documentation
2=====================
3
4Overview
5--------
6
7PostGIS documentation is written in DocBook XML. The input file is
8``postgis.xml``, which in turn includes all the individual chapter XML files.
9From that file we can publish several formats, including HTML and PDF.
10
11Make targets
12------------
13
14``make``
15  same as ``make comments``
16
17``make install``
18  same as ``make comments-install``
19
20``make uninstall``
21  same as ``make comments-uninstall``
22
23``make html``
24  generates a single-file ``html/postgis.html``
25
26``make chunked-html``
27  generates a separate html file for every chapter or section break
28
29``make pdf``
30  generates a single PDF file with the PostGIS version as a filename
31
32``make images``
33  generates all the images used in the HTML and PDF targets
34
35``make comments``
36  generates an SQL script that add COMMENTs for every function (derived from
37  the documentation)
38
39``make doxygen``
40  generates the developer's documentation using Doxygen
41
42``make comments-install``
43  copies the ``postgis-comments.sql`` script to the PostgreSQL ``contrib``
44  directory
45
46``make comments-uninstall``
47  removes the ``postgis-comments.sql`` script from the ``contrib`` directory
48
49``make clean``
50  removes generated files except comments
51
52``make maintainer-clean``
53  removes all generated files (including comments)
54
55
56Requirements
57------------
58
59To generate the html files and the comments:
60 * xsltproc - http://xmlsoft.org/xslt/xsltproc2.html
61 * DocBook XSL stylesheets
62 * MathML 3 DTD - http://www.w3.org/Math/DTD/
63
64To generate the images:
65 * ImageMagick - http://www.imagemagick.org/
66
67To generate a PDF:
68 * dblatex - http://dblatex.sourceforge.net
69
70To generate the developer's documentation:
71 * Doxygen - http://www.stack.nl/~dimitri/doxygen/
72 * Graphviz - http://www.graphviz.org/
73
74How to
75------
76
77To generate images used in the documentation, follow these instructions on the
78PostGIS wiki: http://trac.osgeo.org/postgis/wiki/DevWikiDocNewFeature
79
80To run garden tests against functions, follow these instructions on the PostGIS
81dev wiki: http://trac.osgeo.org/postgis/wiki/DevWikiGardenTest
Note: See TracBrowser for help on using the repository browser.