File: sphinx-autogen.1

package info (click to toggle)
sphinx 1.6.5-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 14,936 kB
  • sloc: python: 50,528; perl: 387; makefile: 296; sh: 80; xml: 16; ansic: 1
file content (48 lines) | stat: -rw-r--r-- 1,242 bytes parent folder | download | duplicates (7)
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
.TH sphinx\-autogen 1 "Aug 2017" "Sphinx 1.6.3" "User Commands"

.SH NAME
sphinx\-autogen \- generate reStructuredText using \fBautosummary\fR
directives

.SH SYNOPSIS
.B sphinx\-autogen
.BI [OPTIONS]
.BI sourcefile
.BI ...

.SH OPTIONS
.TP
\fB\-o\fR, \fB\-\-output-dir=\fIoutput_dir\fR
the directory the output files should be written to
.TP
\fB\-s\fR, \fB\-\-suffix=\fIsuffix\fR
the suffix of the written files (defaults to rst)
.TP
\fB\-t\fR, \fB\-\-templates=\fIdirectory\fR
custom template directory
.TP
\fB\-i\fR, \fB\-\-imported\-members\fR
whether to document imported members (defaults to False)

.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-doc.org/" "The Sphinx website"

.SH AUTHOR
This man page was written by Jan Dittberner <jan@dittberner.info> for
the Debian project (but may be used by others).