*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> gendoc (1)              



NAME    [Toc]    [Back]

       gendoc - Documentation generation from Python source files

SYNOPSIS    [Toc]    [Back]

       gendoc  [-v]  [-u]  [-p|-i] [-h head] [-f format] [key=value ...] files

DESCRIPTION    [Toc]    [Back]

       This manual page documents briefly the  gendoc  command.   This	manual
       page  was  written  for	the  Debian GNU/Linux distribution because the
       original program does not have a manual page.

       gendoc scans one or several python modules for  documentation  strings.
       From  the  documentation  strings, manual pages are generated in any of
       FrameMaker MIF, MML, HTML and ASCII formats.

       Note that you can give multiple format options at once.	It  is	a  lot
       faster,	since  the  the source files are only parsed/imported and traversed

       Currently the following formatters are supported:

       ASCII  Produce simple ascii text.

       HTML   Produce a set of HTML files.

       HTMLg  Same as above using Robin Friedrich's HTMLgen module.

       MIF    FrameMaker's Maker Interchange Format.

       MML    FrameMaker's Maker Markup Language.

OPTIONS    [Toc]    [Back]

       -d dir Save generated files in the *dir* directory.

       -f format
	      Generate files using the formatter *format*.

       -h head
	      Generate a head page with  references  to  all  generated  pages
	      (HTML only).

       -p     Parse source files for docstrings (default).

       -i     Import files for docstrings.

       -u     Include private methods starting with single '_'.

       -v     Verbose mode.

	      Pass formatter options. These options are used to send arguments
	      to formatters. These definitions can be put in  the  environment
	      as well. Currently only one such option is supported.

	      Generate top page as an HTML framed document.

SEE ALSO    [Toc]    [Back]

       See /usr/doc/python-gendoc/ for more information.

[ Back ]
 Similar pages
Name OS Title
podchecker OpenBSD check the syntax of POD format documentation files
podchecker Linux check the syntax of POD format documentation files
bobo Linux Publish Python objects on web servers (command line version)
exstr IRIX extract strings from source files
tic Tru64 Translates terminfo files from source to compiled format
whereis Linux locate the binary, source, and manual page files for a command
val Tru64 Validates Source Code Control System (SCCS) files
admin Tru64 Creates and initializes or changes (administers) Source Code Control System (SCCS) files
what Tru64 Displays identifying information for Source Code Control System (SCCS) files
readcomponent IRIX sets the component source within the framebuffer source for pixels that various routines read, useful primaril
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service