MobileBlur

Hex Artifact Content
Login

Artifact 9290b4f39490f78c45b303457a0c0ee8cd2502f2:


0000: 5b 65 70 79 64 6f 63 5d 20 23 20 45 70 79 64 6f  [epydoc] # Epydo
0010: 63 20 73 65 63 74 69 6f 6e 20 6d 61 72 6b 65 72  c section marker
0020: 20 28 72 65 71 75 69 72 65 64 20 62 79 20 43 6f   (required by Co
0030: 6e 66 69 67 50 61 72 73 65 72 29 0d 0a 0d 0a 23  nfigParser)....#
0040: 20 54 68 65 20 6c 69 73 74 20 6f 66 20 6f 62 6a   The list of obj
0050: 65 63 74 73 20 74 6f 20 64 6f 63 75 6d 65 6e 74  ects to document
0060: 2e 20 20 4f 62 6a 65 63 74 73 20 63 61 6e 20 62  .  Objects can b
0070: 65 20 6e 61 6d 65 64 20 75 73 69 6e 67 0d 0a 23  e named using..#
0080: 20 64 6f 74 74 65 64 20 6e 61 6d 65 73 2c 20 6d   dotted names, m
0090: 6f 64 75 6c 65 20 66 69 6c 65 6e 61 6d 65 73 2c  odule filenames,
00a0: 20 6f 72 20 70 61 63 6b 61 67 65 20 64 69 72 65   or package dire
00b0: 63 74 6f 72 79 20 6e 61 6d 65 73 2e 0d 0a 23 20  ctory names...# 
00c0: 41 6c 69 61 73 65 73 20 66 6f 72 20 74 68 69 73  Aliases for this
00d0: 20 6f 70 74 69 6f 6e 20 69 6e 63 6c 75 64 65 20   option include 
00e0: 22 6f 62 6a 65 63 74 73 22 20 61 6e 64 20 22 76  "objects" and "v
00f0: 61 6c 75 65 73 22 2e 0d 0a 6d 6f 64 75 6c 65 73  alues"...modules
0100: 3a 20 67 6c 75 6f 6e 2f 2a 2e 70 79 0d 0a 0d 0a  : gluon/*.py....
0110: 23 20 54 68 65 20 74 79 70 65 20 6f 66 20 6f 75  # The type of ou
0120: 74 70 75 74 20 74 68 61 74 20 73 68 6f 75 6c 64  tput that should
0130: 20 62 65 20 67 65 6e 65 72 61 74 65 64 2e 20 20   be generated.  
0140: 53 68 6f 75 6c 64 20 62 65 20 6f 6e 65 0d 0a 23  Should be one..#
0150: 20 6f 66 3a 20 68 74 6d 6c 2c 20 74 65 78 74 2c   of: html, text,
0160: 20 6c 61 74 65 78 2c 20 64 76 69 2c 20 70 73 2c   latex, dvi, ps,
0170: 20 70 64 66 2e 0d 0a 23 6f 75 74 70 75 74 3a 20   pdf...#output: 
0180: 6c 61 74 65 78 0d 0a 6f 75 74 70 75 74 3a 20 68  latex..output: h
0190: 74 6d 6c 0d 0a 0d 0a 23 20 54 68 65 20 70 61 74  tml....# The pat
01a0: 68 20 74 6f 20 74 68 65 20 6f 75 74 70 75 74 20  h to the output 
01b0: 64 69 72 65 63 74 6f 72 79 2e 20 20 4d 61 79 20  directory.  May 
01c0: 62 65 20 72 65 6c 61 74 69 76 65 20 6f 72 20 61  be relative or a
01d0: 62 73 6f 6c 75 74 65 2e 0d 0a 74 61 72 67 65 74  bsolute...target
01e0: 3a 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2f 65  : applications/e
01f0: 78 61 6d 70 6c 65 73 2f 73 74 61 74 69 63 2f 65  xamples/static/e
0200: 70 79 64 6f 63 0d 0a 23 74 61 72 67 65 74 3a 20  pydoc..#target: 
0210: 64 6f 63 73 0d 0a 0d 0a 23 20 41 6e 20 69 6e 74  docs....# An int
0220: 65 67 65 72 20 69 6e 64 69 63 61 74 69 6e 67 20  eger indicating 
0230: 68 6f 77 20 76 65 72 62 6f 73 65 20 65 70 79 64  how verbose epyd
0240: 6f 63 20 73 68 6f 75 6c 64 20 62 65 2e 20 20 54  oc should be.  T
0250: 68 65 20 64 65 66 61 75 6c 74 0d 0a 23 20 76 61  he default..# va
0260: 6c 75 65 20 69 73 20 30 3b 20 6e 65 67 61 74 69  lue is 0; negati
0270: 76 65 20 76 61 6c 75 65 73 20 77 69 6c 6c 20 73  ve values will s
0280: 75 70 70 72 65 73 73 20 77 61 72 6e 69 6e 67 73  uppress warnings
0290: 20 61 6e 64 20 65 72 72 6f 72 73 3b 0d 0a 23 20   and errors;..# 
02a0: 70 6f 73 69 74 69 76 65 20 76 61 6c 75 65 73 20  positive values 
02b0: 77 69 6c 6c 20 67 69 76 65 20 6d 6f 72 65 20 76  will give more v
02c0: 65 72 62 6f 73 65 20 6f 75 74 70 75 74 2e 0d 0a  erbose output...
02d0: 76 65 72 62 6f 73 69 74 79 3a 20 30 0d 0a 0d 0a  verbosity: 0....
02e0: 23 20 41 20 62 6f 6f 6c 65 61 6e 20 76 61 6c 75  # A boolean valu
02f0: 65 20 69 6e 64 69 63 61 74 69 6e 67 20 74 68 61  e indicating tha
0300: 74 20 45 70 79 64 6f 63 20 73 68 6f 75 6c 64 20  t Epydoc should 
0310: 73 68 6f 77 20 61 20 74 72 61 63 65 62 61 63 6b  show a traceback
0320: 0d 0a 23 20 69 6e 20 63 61 73 65 20 6f 66 20 75  ..# in case of u
0330: 6e 65 78 70 65 63 74 65 64 20 65 72 72 6f 72 2e  nexpected error.
0340: 20 42 79 20 64 65 66 61 75 6c 74 20 64 6f 6e 27   By default don'
0350: 74 20 73 68 6f 77 20 74 72 61 63 65 62 61 63 6b  t show traceback
0360: 73 0d 0a 64 65 62 75 67 3a 20 30 0d 0a 0d 0a 23  s..debug: 0....#
0370: 20 49 66 20 54 72 75 65 2c 20 64 6f 6e 27 74 20   If True, don't 
0380: 74 72 79 20 74 6f 20 75 73 65 20 63 6f 6c 6f 72  try to use color
0390: 73 20 6f 72 20 63 75 72 73 6f 72 20 63 6f 6e 74  s or cursor cont
03a0: 72 6f 6c 20 77 68 65 6e 20 64 6f 69 6e 67 0d 0a  rol when doing..
03b0: 23 20 74 65 78 74 75 61 6c 20 6f 75 74 70 75 74  # textual output
03c0: 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20 46 61  . The default Fa
03d0: 6c 73 65 20 61 73 73 75 6d 65 73 20 61 20 72 69  lse assumes a ri
03e0: 63 68 20 74 65 78 74 20 70 72 6f 6d 70 74 0d 0a  ch text prompt..
03f0: 73 69 6d 70 6c 65 2d 74 65 72 6d 3a 20 30 0d 0a  simple-term: 0..
0400: 0d 0a 23 23 23 20 47 65 6e 65 72 61 74 69 6f 6e  ..### Generation
0410: 20 6f 70 74 69 6f 6e 73 0d 0a 0d 0a 23 20 54 68   options....# Th
0420: 65 20 64 65 66 61 75 6c 74 20 6d 61 72 6b 75 70  e default markup
0430: 20 6c 61 6e 67 75 61 67 65 20 66 6f 72 20 64 6f   language for do
0440: 63 73 74 72 69 6e 67 73 2c 20 66 6f 72 20 6d 6f  cstrings, for mo
0450: 64 75 6c 65 73 20 74 68 61 74 20 64 6f 0d 0a 23  dules that do..#
0460: 20 6e 6f 74 20 64 65 66 69 6e 65 20 5f 5f 64 6f   not define __do
0470: 63 66 6f 72 6d 61 74 5f 5f 2e 20 20 44 65 66 61  cformat__.  Defa
0480: 75 6c 74 73 20 74 6f 20 65 70 79 74 65 78 74 2e  ults to epytext.
0490: 0d 0a 64 6f 63 66 6f 72 6d 61 74 3a 20 65 70 79  ..docformat: epy
04a0: 74 65 78 74 0d 0a 0d 0a 23 20 57 68 65 74 68 65  text....# Whethe
04b0: 72 20 6f 72 20 6e 6f 74 20 70 61 72 73 69 6e 67  r or not parsing
04c0: 20 73 68 6f 75 6c 64 20 62 65 20 75 73 65 64 20   should be used 
04d0: 74 6f 20 65 78 61 6d 69 6e 65 20 6f 62 6a 65 63  to examine objec
04e0: 74 73 2e 0d 0a 70 61 72 73 65 3a 20 79 65 73 0d  ts...parse: yes.
04f0: 0a 0d 0a 23 20 57 68 65 74 68 65 72 20 6f 72 20  ...# Whether or 
0500: 6e 6f 74 20 69 6e 74 72 6f 73 70 65 63 74 69 6f  not introspectio
0510: 6e 20 73 68 6f 75 6c 64 20 62 65 20 75 73 65 64  n should be used
0520: 20 74 6f 20 65 78 61 6d 69 6e 65 20 6f 62 6a 65   to examine obje
0530: 63 74 73 2e 0d 0a 69 6e 74 72 6f 73 70 65 63 74  cts...introspect
0540: 3a 20 79 65 73 0d 0a 0d 0a 23 20 44 6f 6e 27 74  : yes....# Don't
0550: 20 65 78 61 6d 69 6e 65 20 69 6e 20 61 6e 79 20   examine in any 
0560: 77 61 79 20 74 68 65 20 6d 6f 64 75 6c 65 73 20  way the modules 
0570: 77 68 6f 73 65 20 64 6f 74 74 65 64 20 6e 61 6d  whose dotted nam
0580: 65 20 6d 61 74 63 68 20 74 68 69 73 0d 0a 23 20  e match this..# 
0590: 72 65 67 75 6c 61 72 20 65 78 70 72 65 73 73 69  regular expressi
05a0: 6f 6e 20 70 61 74 74 65 72 6e 2e 0d 0a 23 65 78  on pattern...#ex
05b0: 63 6c 75 64 65 3a 0d 0a 0d 0a 23 20 44 6f 6e 27  clude:....# Don'
05c0: 74 20 70 65 72 66 6f 72 6d 20 69 6e 74 72 6f 73  t perform intros
05d0: 70 65 63 74 69 6f 6e 20 6f 6e 20 74 68 65 20 6d  pection on the m
05e0: 6f 64 75 6c 65 73 20 77 68 6f 73 65 20 64 6f 74  odules whose dot
05f0: 74 65 64 20 6e 61 6d 65 20 6d 61 74 63 68 20 74  ted name match t
0600: 68 69 73 0d 0a 23 20 72 65 67 75 6c 61 72 20 65  his..# regular e
0610: 78 70 72 65 73 73 69 6f 6e 20 70 61 74 74 65 72  xpression patter
0620: 6e 2e 0d 0a 23 65 78 63 6c 75 64 65 2d 69 6e 74  n...#exclude-int
0630: 72 6f 73 70 65 63 74 3a 0d 0a 0d 0a 23 20 44 6f  rospect:....# Do
0640: 6e 27 74 20 70 65 72 66 6f 72 6d 20 70 61 72 73  n't perform pars
0650: 69 6e 67 20 6f 6e 20 74 68 65 20 6d 6f 64 75 6c  ing on the modul
0660: 65 73 20 77 68 6f 73 65 20 64 6f 74 74 65 64 20  es whose dotted 
0670: 6e 61 6d 65 20 6d 61 74 63 68 20 74 68 69 73 0d  name match this.
0680: 0a 23 20 72 65 67 75 6c 61 72 20 65 78 70 72 65  .# regular expre
0690: 73 73 69 6f 6e 20 70 61 74 74 65 72 6e 2e 0d 0a  ssion pattern...
06a0: 23 65 78 63 6c 75 64 65 2d 70 61 72 73 65 3a 0d  #exclude-parse:.
06b0: 0a 0d 0a 23 20 54 68 65 20 66 6f 72 6d 61 74 20  ...# The format 
06c0: 66 6f 72 20 73 68 6f 77 69 6e 67 20 69 6e 68 65  for showing inhe
06d0: 72 69 74 61 6e 63 65 20 6f 62 6a 65 63 74 73 2e  ritance objects.
06e0: 0d 0a 23 20 49 74 20 73 68 6f 75 6c 64 20 62 65  ..# It should be
06f0: 20 6f 6e 65 20 6f 66 3a 20 27 67 72 6f 75 70 65   one of: 'groupe
0700: 64 27 2c 20 27 6c 69 73 74 65 64 27 2c 20 27 69  d', 'listed', 'i
0710: 6e 63 6c 75 64 65 64 27 2e 0d 0a 69 6e 68 65 72  ncluded'...inher
0720: 69 74 61 6e 63 65 3a 20 6c 69 73 74 65 64 0d 0a  itance: listed..
0730: 0d 0a 23 20 57 68 65 74 68 65 72 20 6f 72 20 6e  ..# Whether or n
0740: 6f 74 20 74 6f 20 69 6e 63 6c 75 64 65 20 70 72  ot to include pr
0750: 69 76 61 74 65 20 76 61 72 69 61 62 6c 65 73 2e  ivate variables.
0760: 20 20 28 45 76 65 6e 20 69 66 20 69 6e 63 6c 75    (Even if inclu
0770: 64 65 64 2c 0d 0a 23 20 70 72 69 76 61 74 65 20  ded,..# private 
0780: 76 61 72 69 61 62 6c 65 73 20 77 69 6c 6c 20 62  variables will b
0790: 65 20 68 69 64 64 65 6e 20 62 79 20 64 65 66 61  e hidden by defa
07a0: 75 6c 74 2e 29 0d 0a 70 72 69 76 61 74 65 3a 20  ult.)..private: 
07b0: 79 65 73 0d 0a 0d 0a 23 20 57 68 65 74 68 65 72  yes....# Whether
07c0: 20 6f 72 20 6e 6f 74 20 74 6f 20 6c 69 73 74 20   or not to list 
07d0: 65 61 63 68 20 6d 6f 64 75 6c 65 27 73 20 69 6d  each module's im
07e0: 70 6f 72 74 73 2e 0d 0a 23 69 6d 70 6f 72 74 73  ports...#imports
07f0: 3a 20 6e 6f 0d 0a 0d 0a 23 20 57 68 65 74 68 65  : no....# Whethe
0800: 72 20 6f 72 20 6e 6f 74 20 74 6f 20 69 6e 63 6c  r or not to incl
0810: 75 64 65 20 73 79 6e 74 61 78 20 68 69 67 68 6c  ude syntax highl
0820: 69 67 68 74 65 64 20 73 6f 75 72 63 65 20 63 6f  ighted source co
0830: 64 65 20 69 6e 0d 0a 23 20 74 68 65 20 6f 75 74  de in..# the out
0840: 70 75 74 20 28 48 54 4d 4c 20 6f 6e 6c 79 29 2e  put (HTML only).
0850: 0d 0a 73 6f 75 72 63 65 63 6f 64 65 3a 20 79 65  ..sourcecode: ye
0860: 73 0d 0a 0d 0a 23 20 57 68 65 74 68 65 72 20 6f  s....# Whether o
0870: 72 20 6e 6f 74 20 74 6f 20 69 6e 63 6c 75 64 65  r not to include
0880: 20 61 20 70 61 67 65 20 77 69 74 68 20 45 70 79   a page with Epy
0890: 64 6f 63 20 6c 6f 67 2c 20 63 6f 6e 74 61 69 6e  doc log, contain
08a0: 69 6e 67 0d 0a 23 20 65 66 66 65 63 74 69 76 65  ing..# effective
08b0: 20 6f 70 74 69 6f 6e 20 61 74 20 74 68 65 20 74   option at the t
08c0: 69 6d 65 20 6f 66 20 67 65 6e 65 72 61 74 69 6f  ime of generatio
08d0: 6e 20 61 6e 64 20 74 68 65 20 72 65 70 6f 72 74  n and the report
08e0: 65 64 20 6c 6f 67 73 2e 0d 0a 69 6e 63 6c 75 64  ed logs...includ
08f0: 65 2d 6c 6f 67 3a 20 6e 6f 0d 0a 0d 0a 23 23 23  e-log: no....###
0900: 20 4f 75 74 70 75 74 20 6f 70 74 69 6f 6e 73 0d   Output options.
0910: 0a 0d 0a 23 20 54 68 65 20 64 6f 63 75 6d 65 6e  ...# The documen
0920: 74 65 64 20 70 72 6f 6a 65 63 74 27 73 20 6e 61  ted project's na
0930: 6d 65 2e 0d 0a 6e 61 6d 65 3a 20 77 65 62 32 70  me...name: web2p
0940: 79 20 57 65 62 20 46 72 61 6d 65 77 6f 72 6b 0d  y Web Framework.
0950: 0a 0d 0a 23 20 54 68 65 20 43 53 53 20 73 74 79  ...# The CSS sty
0960: 6c 65 73 68 65 65 74 20 66 6f 72 20 48 54 4d 4c  lesheet for HTML
0970: 20 6f 75 74 70 75 74 2e 20 20 43 61 6e 20 62 65   output.  Can be
0980: 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 61 20 62   the name of a b
0990: 75 69 6c 74 2d 69 6e 0d 0a 23 20 73 74 79 6c 65  uilt-in..# style
09a0: 73 68 65 65 74 2c 20 6f 72 20 74 68 65 20 6e 61  sheet, or the na
09b0: 6d 65 20 6f 66 20 61 20 66 69 6c 65 2e 0d 0a 63  me of a file...c
09c0: 73 73 3a 20 65 70 79 64 6f 63 2e 63 73 73 0d 0a  ss: epydoc.css..
09d0: 0d 0a 23 20 54 68 65 20 64 6f 63 75 6d 65 6e 74  ..# The document
09e0: 65 64 20 70 72 6f 6a 65 63 74 27 73 20 55 52 4c  ed project's URL
09f0: 2e 0d 0a 75 72 6c 3a 20 68 74 74 70 3a 2f 2f 77  ...url: http://w
0a00: 77 77 2e 77 65 62 32 70 79 2e 63 6f 6d 0d 0a 0d  ww.web2py.com...
0a10: 0a 23 20 48 54 4d 4c 20 63 6f 64 65 20 66 6f 72  .# HTML code for
0a20: 20 74 68 65 20 70 72 6f 6a 65 63 74 20 6c 69 6e   the project lin
0a30: 6b 20 69 6e 20 74 68 65 20 6e 61 76 69 67 61 74  k in the navigat
0a40: 69 6f 6e 20 62 61 72 2e 20 20 49 66 20 6c 65 66  ion bar.  If lef
0a50: 74 0d 0a 23 20 75 6e 73 70 65 63 69 66 69 65 64  t..# unspecified
0a60: 2c 20 74 68 65 20 70 72 6f 6a 65 63 74 20 6c 69  , the project li
0a70: 6e 6b 20 77 69 6c 6c 20 62 65 20 67 65 6e 65 72  nk will be gener
0a80: 61 74 65 64 20 62 61 73 65 64 20 6f 6e 20 74 68  ated based on th
0a90: 65 0d 0a 23 20 70 72 6f 6a 65 63 74 27 73 20 6e  e..# project's n
0aa0: 61 6d 65 20 61 6e 64 20 55 52 4c 2e 0d 0a 23 20  ame and URL...# 
0ab0: 6c 69 6e 6b 3a 20 3c 61 20 68 72 65 66 3d 22 68  link: <a href="h
0ac0: 74 74 70 3a 2f 2f 77 77 77 2e 77 65 62 32 70 79  ttp://www.web2py
0ad0: 2e 63 6f 6d 22 3e 77 65 62 32 70 79 3c 2f 61 3e  .com">web2py</a>
0ae0: 0d 0a 0d 0a 23 20 54 68 65 20 22 74 6f 70 22 20  ....# The "top" 
0af0: 70 61 67 65 20 66 6f 72 20 74 68 65 20 64 6f 63  page for the doc
0b00: 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 43 61 6e  umentation.  Can
0b10: 20 62 65 20 61 20 55 52 4c 2c 20 74 68 65 20 6e   be a URL, the n
0b20: 61 6d 65 0d 0a 23 20 6f 66 20 61 20 6d 6f 64 75  ame..# of a modu
0b30: 6c 65 20 6f 72 20 63 6c 61 73 73 2c 20 6f 72 20  le or class, or 
0b40: 6f 6e 65 20 6f 66 20 74 68 65 20 73 70 65 63 69  one of the speci
0b50: 61 6c 20 6e 61 6d 65 73 20 22 74 72 65 65 73 2e  al names "trees.
0b60: 68 74 6d 6c 22 2c 0d 0a 23 20 22 69 6e 64 69 63  html",..# "indic
0b70: 65 73 2e 68 74 6d 6c 22 2c 20 6f 72 20 22 68 65  es.html", or "he
0b80: 6c 70 2e 68 74 6d 6c 22 0d 0a 23 74 6f 70 3a 20  lp.html"..#top: 
0b90: 6f 73 2e 70 61 74 68 0d 0a 0d 0a 23 20 41 6e 20  os.path....# An 
0ba0: 61 6c 74 65 72 6e 61 74 69 76 65 20 68 65 6c 70  alternative help
0bb0: 20 66 69 6c 65 2e 20 20 54 68 65 20 6e 61 6d 65   file.  The name
0bc0: 64 20 66 69 6c 65 20 73 68 6f 75 6c 64 20 63 6f  d file should co
0bd0: 6e 74 61 69 6e 20 74 68 65 0d 0a 23 20 62 6f 64  ntain the..# bod
0be0: 79 20 6f 66 20 61 6e 20 48 54 4d 4c 20 66 69 6c  y of an HTML fil
0bf0: 65 3b 20 6e 61 76 69 67 61 74 69 6f 6e 20 62 61  e; navigation ba
0c00: 72 73 20 77 69 6c 6c 20 62 65 20 61 64 64 65 64  rs will be added
0c10: 20 74 6f 20 69 74 2e 0d 0a 23 68 65 6c 70 3a 20   to it...#help: 
0c20: 6d 79 5f 68 65 6c 70 66 69 6c 65 2e 68 74 6d 6c  my_helpfile.html
0c30: 0d 0a 0d 0a 23 20 57 68 65 74 68 65 72 20 6f 72  ....# Whether or
0c40: 20 6e 6f 74 20 74 6f 20 69 6e 63 6c 75 64 65 20   not to include 
0c50: 61 20 66 72 61 6d 65 73 2d 62 61 73 65 64 20 74  a frames-based t
0c60: 61 62 6c 65 20 6f 66 20 63 6f 6e 74 65 6e 74 73  able of contents
0c70: 2e 0d 0a 66 72 61 6d 65 73 3a 20 79 65 73 0d 0a  ...frames: yes..
0c80: 0d 0a 23 20 57 68 65 74 68 65 72 20 65 61 63 68  ..# Whether each
0c90: 20 63 6c 61 73 73 20 73 68 6f 75 6c 64 20 62 65   class should be
0ca0: 20 6c 69 73 74 65 64 20 69 6e 20 69 74 73 20 6f   listed in its o
0cb0: 77 6e 20 73 65 63 74 69 6f 6e 20 77 68 65 6e 0d  wn section when.
0cc0: 0a 23 20 67 65 6e 65 72 61 74 69 6e 67 20 4c 61  .# generating La
0cd0: 54 65 58 20 6f 72 20 50 44 46 20 6f 75 74 70 75  TeX or PDF outpu
0ce0: 74 2e 0d 0a 73 65 70 61 72 61 74 65 2d 63 6c 61  t...separate-cla
0cf0: 73 73 65 73 3a 20 6e 6f 0d 0a 0d 0a 0d 0a 23 23  sses: no......##
0d00: 23 20 41 50 49 20 6c 69 6e 6b 69 6e 67 20 6f 70  # API linking op
0d10: 74 69 6f 6e 73 0d 0a 0d 0a 23 20 44 65 66 69 6e  tions....# Defin
0d20: 65 20 61 20 6e 65 77 20 41 50 49 20 64 6f 63 75  e a new API docu
0d30: 6d 65 6e 74 2e 20 20 41 20 6e 65 77 20 69 6e 74  ment.  A new int
0d40: 65 72 70 72 65 74 65 64 20 74 65 78 74 20 72 6f  erpreted text ro
0d50: 6c 65 0d 0a 23 20 77 69 6c 6c 20 62 65 20 63 72  le..# will be cr
0d60: 65 61 74 65 64 0d 0a 23 65 78 74 65 72 6e 61 6c  eated..#external
0d70: 2d 61 70 69 3a 20 65 70 79 64 6f 63 0d 0a 0d 0a  -api: epydoc....
0d80: 23 20 55 73 65 20 74 68 65 20 72 65 63 6f 72 64  # Use the record
0d90: 73 20 69 6e 20 74 68 69 73 20 66 69 6c 65 20 74  s in this file t
0da0: 6f 20 72 65 73 6f 6c 76 65 20 6f 62 6a 65 63 74  o resolve object
0db0: 73 20 69 6e 20 74 68 65 20 41 50 49 20 6e 61 6d  s in the API nam
0dc0: 65 64 20 4e 41 4d 45 2e 0d 0a 23 65 78 74 65 72  ed NAME...#exter
0dd0: 6e 61 6c 2d 61 70 69 2d 66 69 6c 65 3a 20 65 70  nal-api-file: ep
0de0: 79 64 6f 63 3a 61 70 69 2d 6f 62 6a 65 63 74 73  ydoc:api-objects
0df0: 2e 74 78 74 0d 0a 0d 0a 23 20 55 73 65 20 74 68  .txt....# Use th
0e00: 69 73 20 55 52 4c 20 70 72 65 66 69 78 20 74 6f  is URL prefix to
0e10: 20 63 6f 6e 66 69 67 75 72 65 20 74 68 65 20 73   configure the s
0e20: 74 72 69 6e 67 20 72 65 74 75 72 6e 65 64 20 66  tring returned f
0e30: 6f 72 20 65 78 74 65 72 6e 61 6c 20 41 50 49 2e  or external API.
0e40: 0d 0a 23 65 78 74 65 72 6e 61 6c 2d 61 70 69 2d  ..#external-api-
0e50: 72 6f 6f 74 3a 20 65 70 79 64 6f 63 3a 68 74 74  root: epydoc:htt
0e60: 70 3a 2f 2f 65 70 79 64 6f 63 2e 73 6f 75 72 63  p://epydoc.sourc
0e70: 65 66 6f 72 67 65 2e 6e 65 74 2f 61 70 69 0d 0a  eforge.net/api..
0e80: 0d 0a 0d 0a 23 23 23 20 47 72 61 70 68 20 6f 70  ....### Graph op
0e90: 74 69 6f 6e 73 0d 0a 0d 0a 23 20 54 68 65 20 6c  tions....# The l
0ea0: 69 73 74 20 6f 66 20 67 72 61 70 68 20 74 79 70  ist of graph typ
0eb0: 65 73 20 74 68 61 74 20 73 68 6f 75 6c 64 20 62  es that should b
0ec0: 65 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20  e automatically 
0ed0: 69 6e 63 6c 75 64 65 64 0d 0a 23 20 69 6e 20 74  included..# in t
0ee0: 68 65 20 6f 75 74 70 75 74 2e 20 20 47 72 61 70  he output.  Grap
0ef0: 68 73 20 61 72 65 20 67 65 6e 65 72 61 74 65 64  hs are generated
0f00: 20 75 73 69 6e 67 20 74 68 65 20 47 72 61 70 68   using the Graph
0f10: 76 69 7a 20 22 64 6f 74 22 0d 0a 23 20 65 78 65  viz "dot"..# exe
0f20: 63 75 74 61 62 6c 65 2e 20 20 47 72 61 70 68 20  cutable.  Graph 
0f30: 74 79 70 65 73 20 69 6e 63 6c 75 64 65 3a 20 22  types include: "
0f40: 63 6c 61 73 73 74 72 65 65 22 2c 20 22 63 61 6c  classtree", "cal
0f50: 6c 67 72 61 70 68 22 2c 0d 0a 23 20 22 75 6d 6c  lgraph",..# "uml
0f60: 63 6c 61 73 73 74 72 65 65 22 2e 20 20 55 73 65  classtree".  Use
0f70: 20 22 61 6c 6c 22 20 74 6f 20 69 6e 63 6c 75 64   "all" to includ
0f80: 65 20 61 6c 6c 20 67 72 61 70 68 20 74 79 70 65  e all graph type
0f90: 73 0d 0a 23 20 67 72 61 70 68 3a 20 75 6d 6c 63  s..# graph: umlc
0fa0: 6c 61 73 73 74 72 65 65 0d 0a 23 20 67 72 61 70  lasstree..# grap
0fb0: 68 3a 20 0d 0a 0d 0a 23 20 54 68 65 20 70 61 74  h: ....# The pat
0fc0: 68 20 74 6f 20 74 68 65 20 47 72 61 70 68 76 69  h to the Graphvi
0fd0: 7a 20 22 64 6f 74 22 20 65 78 65 63 75 74 61 62  z "dot" executab
0fe0: 6c 65 2c 20 75 73 65 64 20 74 6f 20 67 65 6e 65  le, used to gene
0ff0: 72 61 74 65 0d 0a 23 20 67 72 61 70 68 73 2e 0d  rate..# graphs..
1000: 0a 23 64 6f 74 70 61 74 68 3a 20 43 3a 2f 68 6f  .#dotpath: C:/ho
1010: 6d 65 2f 67 72 61 70 68 76 69 7a 2f 62 69 6e 2f  me/graphviz/bin/
1020: 64 6f 74 2e 65 78 65 0d 0a 23 64 6f 74 70 61 74  dot.exe..#dotpat
1030: 68 3a 20 2f 41 70 70 6c 69 63 61 74 69 6f 6e 73  h: /Applications
1040: 2f 47 72 61 70 68 76 69 7a 2e 61 70 70 2f 43 6f  /Graphviz.app/Co
1050: 6e 74 65 6e 74 73 2f 4d 61 63 4f 53 2f 64 6f 74  ntents/MacOS/dot
1060: 0d 0a 0d 0a 23 20 54 68 65 20 6e 61 6d 65 20 6f  ....# The name o
1070: 66 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 70 73  f one or more ps
1080: 74 61 74 20 66 69 6c 65 73 20 28 67 65 6e 65 72  tat files (gener
1090: 61 74 65 64 20 62 79 20 74 68 65 20 70 72 6f 66  ated by the prof
10a0: 69 6c 65 0d 0a 23 20 6f 72 20 68 6f 74 73 68 6f  ile..# or hotsho
10b0: 74 20 6d 6f 64 75 6c 65 29 2e 20 20 54 68 65 73  t module).  Thes
10c0: 65 20 61 72 65 20 75 73 65 64 20 74 6f 20 67 65  e are used to ge
10d0: 6e 65 72 61 74 65 20 63 61 6c 6c 20 67 72 61 70  nerate call grap
10e0: 68 73 2e 0d 0a 23 70 73 74 61 74 3a 20 70 72 6f  hs...#pstat: pro
10f0: 66 69 6c 65 2e 6f 75 74 0d 0a 0d 0a 23 20 53 70  file.out....# Sp
1100: 65 63 69 66 79 20 74 68 65 20 66 6f 6e 74 20 75  ecify the font u
1110: 73 65 64 20 74 6f 20 67 65 6e 65 72 61 74 65 20  sed to generate 
1120: 47 72 61 70 68 76 69 7a 20 67 72 61 70 68 73 2e  Graphviz graphs.
1130: 0d 0a 23 20 28 65 2e 67 2e 2c 20 68 65 6c 76 65  ..# (e.g., helve
1140: 74 69 63 61 20 6f 72 20 74 69 6d 65 73 29 2e 0d  tica or times)..
1150: 0a 23 20 67 72 61 70 68 2d 66 6f 6e 74 3a 20 42  .# graph-font: B
1160: 69 74 73 74 72 65 61 6d 20 56 65 72 61 20 53 61  itstream Vera Sa
1170: 6e 73 0d 0a 67 72 61 70 68 2d 66 6f 6e 74 3a 20  ns..graph-font: 
1180: 48 65 6c 76 65 74 69 63 61 0d 0a 0d 0a 23 20 53  Helvetica....# S
1190: 70 65 63 69 66 79 20 74 68 65 20 66 6f 6e 74 20  pecify the font 
11a0: 73 69 7a 65 20 75 73 65 64 20 74 6f 20 67 65 6e  size used to gen
11b0: 65 72 61 74 65 20 47 72 61 70 68 76 69 7a 20 67  erate Graphviz g
11c0: 72 61 70 68 73 2e 0d 0a 67 72 61 70 68 2d 66 6f  raphs...graph-fo
11d0: 6e 74 2d 73 69 7a 65 3a 20 31 30 0d 0a 0d 0a 23  nt-size: 10....#
11e0: 23 23 20 52 65 74 75 72 6e 20 76 61 6c 75 65 20  ## Return value 
11f0: 6f 70 74 69 6f 6e 73 0d 0a 0d 0a 23 20 54 68 65  options....# The
1200: 20 63 6f 6e 64 69 74 69 6f 6e 20 75 70 6f 6e 20   condition upon 
1210: 77 68 69 63 68 20 45 70 79 64 6f 63 20 73 68 6f  which Epydoc sho
1220: 75 6c 64 20 65 78 69 74 20 77 69 74 68 20 61 20  uld exit with a 
1230: 6e 6f 6e 2d 7a 65 72 6f 0d 0a 23 20 65 78 69 74  non-zero..# exit
1240: 20 73 74 61 74 75 73 2e 20 50 6f 73 73 69 62 6c   status. Possibl
1250: 65 20 76 61 6c 75 65 73 20 61 72 65 20 65 72 72  e values are err
1260: 6f 72 2c 20 77 61 72 6e 69 6e 67 2c 20 64 6f 63  or, warning, doc
1270: 73 74 72 69 6e 67 5f 77 61 72 6e 69 6e 67 0d 0a  string_warning..
1280: 23 66 61 69 6c 2d 6f 6e 3a 20 65 72 72 6f 72 0d  #fail-on: error.
1290: 0a                                               .