home *** CD-ROM | disk | FTP | other *** search
/ Big Green CD 8 / BGCD_8_Dev.iso / OPENSTEP / Languages / Python / python-14-src / Doc / Makefile < prev    next >
Encoding:
Makefile  |  1997-01-17  |  7.4 KB  |  237 lines

  1. # Makefile for Python documentation
  2. # ---------------------------------
  3. #
  4. # See also the README file.
  5. #
  6. # This is a bit of a mess.  The main documents are:
  7. #   tut -- Tutorial (file tut.tex)
  8. #   lib -- Library Reference (file lib.tex, inputs lib*.tex)
  9. #   ext -- Extending and Embedding (file ext.tex)
  10. #
  11. # The Reference Manual is now maintained as a FrameMaker document.
  12. # See the subdirectory ref; PostScript is included as ref/ref.ps.
  13. # (In the future, the Tutorial will also be converted to FrameMaker;
  14. # the other documents will be maintained in a text format such
  15. # as LaTeX or perhaps TIM.)
  16. #
  17. # The main target "make all" creates DVI and PostScript for these
  18. # four.  You can also do "make lib" (etc.) to process individual
  19. # documents.
  20. #
  21. # There's also:
  22. #   qua -- Paper published in the CWI Quarterly (file qua.tex)
  23. #
  24. # There's one local style file: myformat.sty.  This defines a number
  25. # of macros that are similar in name and intent as macros in Texinfo
  26. # (e.g. \code{...} and \emph{...}), as well as a number of
  27. # environments for formatting function and data definitions, also in
  28. # the style of Texinfo.
  29. #
  30. # Everything is processed by LaTeX.  The following tools are used:
  31. #   latex
  32. #   makeindex
  33. #   dvips
  34. #   bibtex (only for formatting qua.tex)
  35. #
  36. # There's a problem with generating the index which has been solved by
  37. # a sed command applied to the index file.  The shell script fix_hack
  38. # does this (the Makefile takes care of calling it).
  39. #
  40. # To preview the dvi files produced by LaTeX it would be useful to
  41. # have xdvi as well.
  42. #
  43. # Additional targets attempt to convert selected LaTeX sources to
  44. # various other formats.  These are generally site specific because
  45. # the tools used are all but universal.  These targets are:
  46. #   l2h -- convert tut, ref, ext (but not lib!) from LaTeX to HTML
  47. #   lib.texi -- convert lib from LaTeX to Texinfo
  48. #   lib.info -- convert lib from Texinfo to Emacs INFO
  49. #   libwww -- convert lib from Texinfo to HTML
  50. # See the README file for more info on these targets.
  51.  
  52. # Customizations -- you *may* have to edit these
  53.  
  54. # Where are the various programs?
  55. LATEX=        latex
  56. BIBTEX=        bibtex
  57. EMACS=        emacs
  58. DVIPS=        dvips -f
  59. MAKEINDEX=    makeindex
  60. PYTHON=        python
  61. MAKEINFO=    makeinfo
  62. L2H=        /ufs/guido/l2h/latex2html
  63. L2HARGS=    -address $$USER@`domainname` -dont_include myformat
  64.  
  65. # Destination directory for output of libwww target.
  66. PARTPARSE=    $(PYTHON) ./partparse.pyc
  67. TEXI2HTMLFLAGS= -d
  68. TEXI2HTML=    $(PYTHON) ./texi2html.pyc
  69. LIBHTMLDIR=    ./python-lib
  70.  
  71. # Install destination -- not used now but might be useful some time...
  72. DESTDIR=    /usr/local
  73. LIBDESTDIR=    $DESTDIR/lib
  74. LIBDEST=    $LIBDESTDIR/python
  75. DOCDESTDIR=    $LIBDEST/doc
  76.  
  77. # Ideally, you shouldn't need to edit beyond this point
  78.  
  79. # Main target
  80. all:    all-ps
  81.  
  82. all-dvi: tut.dvi lib.dvi ext.dvi
  83. all-ps:    tut.ps lib.ps ext.ps
  84.  
  85. # Individual document fake targets
  86. tut:    tut.ps
  87. lib:    lib.ps
  88. ext:    ext.ps
  89.  
  90. # CWI Quarterly document fake target
  91. qua:    qua.ps
  92.  
  93. # Dependencies
  94. tut.dvi lib.dvi ext.dvi: myformat.sty fix_hack
  95.  
  96. # Tutorial document
  97. tut.dvi: tut.tex 
  98.     $(LATEX) tut
  99.     $(LATEX) tut
  100.  
  101. tut.ps:    tut.dvi
  102.     $(DVIPS) tut >tut.ps
  103.  
  104. # LaTeX source files for the Python Library Reference
  105. LIBFILES = lib.tex \
  106.     libintro.tex libobjs.tex libtypes.tex libexcs.tex libfuncs.tex \
  107.     libpython.tex libsys.tex libtypes2.tex libtraceback.tex libpickle.tex \
  108.     libshelve.tex libcopy.tex libmarshal.tex libimp.tex libparser.tex \
  109.     libbltin.tex libmain.tex libstrings.tex libstring.tex libregex.tex \
  110.     libregsub.tex libstruct.tex libmisc.tex libmath.tex librand.tex \
  111.     libwhrandom.tex libarray.tex liballos.tex libos.tex libtime.tex \
  112.     libgetopt.tex libtempfile.tex liberrno.tex libsomeos.tex libsignal.tex \
  113.     libsocket.tex libselect.tex libthread.tex libunix.tex libposix.tex \
  114.     libppath.tex libpwd.tex libgrp.tex libcrypt.tex libdbm.tex libgdbm.tex \
  115.     libtermios.tex libfcntl.tex libposixfile.tex libsyslog.tex libpdb.tex \
  116.     libprofile.tex libwww.tex libcgi.tex liburllib.tex libhttplib.tex \
  117.     libftplib.tex libgopherlib.tex libnntplib.tex liburlparse.tex \
  118.     libhtmllib.tex libsgmllib.tex librfc822.tex libmimetools.tex \
  119.     libbinascii.tex libmm.tex libaudioop.tex libimageop.tex libaifc.tex \
  120.     libjpeg.tex librgbimg.tex libcrypto.tex libmd5.tex libmpz.tex \
  121.     librotor.tex libmac.tex libctb.tex libmacconsole.tex libmacdnr.tex \
  122.     libmacfs.tex libmacos.tex libmacostools.tex libmactcp.tex \
  123.     libmacspeech.tex libmacui.tex libstdwin.tex libsgi.tex libal.tex \
  124.     libcd.tex libfl.tex libfm.tex libgl.tex libimgfile.tex libsun.tex \
  125.     libxdrlib.tex libimghdr.tex \
  126.     librestricted.tex librexec.tex libbastion.tex \
  127.     libformatter.tex
  128.  
  129. # Library document
  130. lib.dvi: $(LIBFILES)
  131.     touch lib.ind
  132.     $(LATEX) lib
  133.     ./fix_hack lib.idx
  134.     $(MAKEINDEX) lib
  135.     $(LATEX) lib
  136.  
  137. lib.ps:    lib.dvi
  138.     $(DVIPS) lib >lib.ps
  139.  
  140. # Extensions document
  141. ext.dvi: ext.tex extref.tex
  142.     touch ext.ind
  143.     $(LATEX) ext
  144.     ./fix_hack ext.idx
  145.     $(MAKEINDEX) ext
  146.     $(LATEX) ext
  147.  
  148. ext.ps:    ext.dvi
  149.     $(DVIPS) ext >ext.ps
  150.  
  151. # Quarterly document
  152. qua.dvi: qua.tex quabib.bib
  153.     $(LATEX) qua
  154.     $(BIBTEX) qua
  155.     $(LATEX) qua
  156.     $(BIBTEX) qua
  157.  
  158. qua.ps:    qua.dvi
  159.     $(DVIPS) qua >qua.ps
  160.  
  161.  
  162. # The remaining part of the Makefile is concerned with various
  163. # conversions, as described above.  See also the README file.
  164.  
  165. .SUFFIXES: .py .pyc
  166.  
  167. .py.pyc:
  168.     $(PYTHON) -c "import $*"
  169.  
  170. .PRECIOUS:    lib.texi
  171.  
  172. lib.texi: lib*.tex texipre.dat texipost.dat partparse.pyc fix.el
  173.     $(PARTPARSE) -o @lib.texi `./whichlibs`
  174.     $(EMACS) -batch -l fix.el -f save-buffer -kill
  175.     mv @lib.texi lib.texi
  176.  
  177. python-lib.info: lib.texi
  178.     -$(MAKEINFO) --footnote-style end --fill-column 72 \
  179.              --paragraph-indent 0 lib.texi
  180.  
  181. lib.info: python-lib.info
  182.  
  183. libwww: lib.texi texi2html.pyc
  184.     if test ! -d $(LIBHTMLDIR); then mkdir $(LIBHTMLDIR); else true; fi
  185.     $(TEXI2HTML) $(TEXI2HTMLFLAGS) lib.texi $(LIBHTMLDIR)
  186.  
  187. # Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
  188. # HTML converter.  For more info on this program, see
  189. # <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.
  190. # (I've had some trouble getting this to work with the netpbm version
  191. # of the pbmplus library; ppmtogif dumped core because giftopnm
  192. # outputs bitmap (pbm) files.  I've fixed this by changing the source
  193. # of LaTeX2HTML to insert a call to pnmtoppm, which I wrote myself.
  194. # You can probably also use "pbmtopgm | pgmtoppm"...
  195.  
  196. # In order to use these targets, you must edit the definition of L2H
  197. # earlier in the Makefile to point to the latex2html program.  Note
  198. # that LaTeX2HTML inserts references to an "icons" directory in each
  199. # page that it generates.  You can customize where these icons are to
  200. # be found; I generally make it point to "../icons" and then create a
  201. # symbolic link to the icons directory in the LaTeX2HTML source at the
  202. # appropriate place.
  203.  
  204. l2h: l2htut l2href l2hext
  205.  
  206. l2htut: tut.dvi
  207.     $(L2H) $(L2HARGS) tut.tex
  208.     @rm -rf python-tut
  209.     mv tut python-tut
  210.  
  211. l2hext: ext.dvi
  212.     $(L2H) $(L2HARGS) ext.tex
  213.     @rm -rf python-ext
  214.     mv ext python-ext
  215.  
  216. # This target doesn't quite work, since l2h doesn't understand the
  217. # funcdesc and similar environments, and turns them into GIF images.
  218. # Use the "libwww" target above instead.
  219. l2hlib: lib.dvi
  220.     $(L2H) $(L2HARGS) lib.tex
  221.     @rm -rf python-lib
  222.     mv lib python-lib
  223.  
  224.  
  225. # Housekeeping targets
  226.  
  227. # Remove temporary files
  228. clean:
  229.     rm -f @* *~ *.aux *.idx *.ilg *.ind *.log *.toc *.blg *.bbl *.pyc
  230.     rm -f *.bak *.orig
  231.     # Sources: .tex, .bib, .sty
  232.     # Useful results: .dvi, .ps, .texi, .info
  233.  
  234. # Remove temporaries as well as final products
  235. clobber: clean
  236.      rm -f *.dvi *.ps *.texi *.info *.info-[0-9]*
  237.