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
|
.TH sphinx\-autogen 1 "Sat, 28 Mar 2009" "Jan Dittberner" "User Commands"
.SH NAME
sphinx\-autogen \- generate ReStructuredText using \fBautosummary\fR
directives
.SH SYNOPSIS
.B sphinx\-autogen
[\-o \fIoutput_dir\fR]
[\-s \fIsuffix\fR]
.BI sourcefile ...
.SH OPTIONS
.TP
\fB\-o \fIoutput_dir\fR
the directory the output files should be written to
.TP
\fB\-s \fIsuffix\fR
the suffix of the written files (defaults to rst)
.SH DESCRIPTION
.B sphinx\-autogen
is a frontend to \fBsphinx.ext.autosummary.generate\fR.
It generates the ReStructuredText files from the \fBautosummary\fR
directives contained in the given input files.
The format of the \fBautosummary\fR directive is documented in the
\fBsphinx.ext.autosummary\fR Python module and can be read using
.B pydoc
.I sphinx.ext.autosummary
.SH SEE ALSO
\fBsphinx\-quickstart\fR(1),
\fBsphinx\-build\fR(1)
.mso www.tmac
.URL "http://sphinx.pocoo.org/" "The Sphinx website"
.SH AUTHOR
This man page was written by Jan Dittberner <jan@dittberner.info> for
the Debian GNU/Linux System (but may be used by others).
|
