1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH ERIC6_DOC 1 "January 31, 2010"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
eric6_doc \- eric6 documentation generator
.SH SYNOPSIS
.B eric6_doc
.RI [ options ] " files" ...
where files can be be either Python modules, package directories or ordinary directories.
.SH DESCRIPTION
This manual page documents briefly the
.B eric6_doc
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
Instead, it has documentation provided in the file /usr/share/doc/eric/README\-eric6\-doc.txt.gz in plain text format.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBeric6_doc\fP is the documentation generator of the eric6 IDE. Source code documentation may be included as ordinary Python doc-strings or as documentation comments. For Quixote Template file (PTL) only documentation comments are available due to the inner workings of Quixote. Documentation comments start with the string ###, followed by the contents and ended by ###. Every line of the documentation comments contents must start with a # (see example below).
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For a complete description, see the Info files.
.TP
.B \-p prefix or \-\-prefix\=prefix
Prepend given prefix to file names.
.TP
.B \-o directory or \-\-outdir\=directory
Generate files in the named directory.
.TP
.B \-R, \-r or \-\-recursive
Perform a recursive search for Python files.
.TP
.B \-x directory or \-\-exclude\=directory
Specify a directory basename to be excluded.
This option may be repeated multiple times.
.TP
.B \-i or \-\-noindex
Don't generate index files.
.TP
.B \-e or \-\-noempty
Don't include empty modules.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-version
Show version of program.
.SH SEE ALSO
.BR eric6 (1),
.BR eric6_api (1),
.BR eric6_browser (1),
.BR eric6_compare (1),
.BR eric6_configure (1),
.BR eric6_diff (1),
.BR eric6_editor (1),
.BR eric6_helpviewer (1),
.BR eric6_iconeditor (1),
.BR eric6_plugininstall (1),
.BR eric6_pluginrepository (1),
.BR eric6_pluginuninstall (1),
.BR eric6_qregexp (1),
.BR eric6_re (1),
.BR eric6_shell (1),
.BR eric6_sqlbrowser (1),
.BR eric6_tray (1),
.BR eric6_trpreviewer (1),
.BR eric6_uipreviewer (1),
.BR eric6_unittest (1),
.BR eric6_webbrowser (1)
.br
.SH AUTHOR
This manual page was written by Torsten Marek <shlomme@gmx.net>,
for the Debian project (but may be used by others).
|
