debug
[platform/upstream/gstreamer.git] / DOCBUILDING
1 Building GStreamer documentation
2
3
4 DOCUMENTATION
5 -------------
6
7 To build the GStreamer documentation you need the following installed (based on Red Hat packages). 
8 These packages comes from rawhide and are the ones that will be in Red Hat 7.3/8.0
9
10 Docbook stuff:
11 sgml-common 
12 xml-common 
13 openjade (needs to be rebuilt from SRPM for Red Hat 7.2)
14 tetex-dvips
15 jadetex
16 docbook-dtds      
17 docbook-style-dsssl 
18 docbook-style-xsl
19 docbook-utils
20
21 XML stuff:
22 libxml2
23 libxml2-python
24 libxml2-devel
25 libxslt
26 libxslt-devel
27 libxslt-python
28
29
30
31 Gtkdoc:
32 gtk-doc
33
34 Other stuff:
35 transfig
36 pdftops
37
38
39
40
41
42 DEVHELP INTEGRATION
43 -------------------
44 Check http://devhelp.sourceforge.net/
45 It's a really nice development app allowing you to look up API stuff
46 from various gtk-doc'd libraries.  GStreamer is one of these ;)
47
48 Currently we keep our devhelp files in CVS until devhelp has settled down.
49
50 We'll keep them in a devhelp/ directory
51
52 For now, I put tools to generate the devhelp files in this dir, as well as
53 the generated devhelp files.  It's easier to have one person generate the
54 devhelp files once in a while than to do it in every build.  Until devhelp
55 settles down or we get a clue, that is ;)
56